Events
Every webhook event queued, with how its delivery went, and sending it again: the safety net after a receiver outage.
| Operation | Endpoint |
|---|---|
| List webhook events | GET /api/events |
| List a delivery's attempts | GET /api/events/{id}/attempts |
| Redeliver events | POST /api/events/redeliver |
| Redeliver one event | POST /api/events/{id}/redeliver |
GET /api/events
/api/eventsList webhook events
Every event addressed to the caller, oldest first and keyset paged by cursor, each with its delivery status and payload: expired, failed and held ones too. An event is listed once it is two minutes old, so a page never moves past one a slower transaction has yet to commit. Filter by types, status, patientId, or (for a MANAGER) subscriberId.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
cursor | query | no | Opaque keyset cursor: a previous answer's nextCursor, passed back verbatim. |
limit | query | no | Page size, 1 to 200. Defaults to 50. |
types | query | no | Only these event types, comma-separated: alert.trigger,patient.inactive. |
status | query | no | Only deliveries in this state. |
patientId | query | no | Only events about this patient: its Signals id, as the payload's patient. |
subscriberId | query | no | Only this subscriber's deliveries, by Signals id or clientId. A subscriber may name only itself. |
Responses
| Status | Meaning |
|---|---|
200 | One page of events. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber. |
404 | subscriberId names no subscriber in this tenant. |
422 | A query parameter failed validation. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
items | EventDocumentSchema[] | yes | |
nextCursor | string | null | yes | Opaque keyset cursor. Pass it back as cursor for the next page; null means this page was the last. Do not construct or parse it. |
GET /api/events/{id}/attempts
/api/events/{id}/attemptsList a delivery's attempts
Each POST made for it, oldest first: when, how long, the status code or the error, and the first 2 KB of the answer.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The delivery's id, an item's id in GET /api/events. |
Responses
| Status | Meaning |
|---|---|
200 | The attempts. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber's delivery. |
404 | No such delivery in this tenant. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
items | AttemptDocumentSchema[] | yes | Oldest first, at most 100. |
POST /api/events/redeliver
/api/events/redeliverRedeliver events
Queues the oldest 1 000 deliveries in status (default failed) queued since since to be sent again, each with a fresh retry ladder: the same webhook-id, so receivers dedupe, and a new webhook-timestamp. An alert is sent whatever its age. Deliveries to a disabled endpoint, and ones being sent right now, are skipped. While it answers queued: 1000, call it again for the next ones.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
status | query | no | The deliveries to send again: failed (the default), expired, held or delivered. |
since | query | yes | Only events queued at or after this time. Required, so a replay is always bounded. |
subscriberId | query | no | Only this subscriber's deliveries, by Signals id or clientId. A subscriber may name only itself. |
Responses
| Status | Meaning |
|---|---|
202 | Queued: how many deliveries will be sent again. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber. |
404 | subscriberId names no subscriber in this tenant. |
422 | A query parameter failed validation, or since is missing. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
queued | number | yes | Deliveries queued to be sent again. |
POST /api/events/{id}/redeliver
/api/events/{id}/redeliverRedeliver one event
Queues this delivery to be sent now, whatever its status, with a fresh retry ladder: the same webhook-id and a new webhook-timestamp. An alert is sent whatever its age.
Requires Basic authentication.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
id | path | yes | The delivery's id, an item's id in GET /api/events. |
Responses
| Status | Meaning |
|---|---|
202 | Queued. |
401 | Missing, malformed or unrecognised Basic credentials. |
403 | Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber's delivery. |
404 | No such delivery in this tenant. |
409 | The endpoint is disabled, or the delivery is being sent right now. |
Response body
| Field | Type | Required | Description |
|---|---|---|---|
queued | number | yes | Deliveries queued to be sent again. |
Updated 28 days ago