Events

Every webhook event queued, with how its delivery went, and sending it again: the safety net after a receiver outage.

OperationEndpoint
List webhook eventsGET /api/events
List a delivery's attemptsGET /api/events/{id}/attempts
Redeliver eventsPOST /api/events/redeliver
Redeliver one eventPOST /api/events/{id}/redeliver

GET /api/events

List 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

NameInRequiredDescription
cursorquerynoOpaque keyset cursor: a previous answer's nextCursor, passed back verbatim.
limitquerynoPage size, 1 to 200. Defaults to 50.
typesquerynoOnly these event types, comma-separated: alert.trigger,patient.inactive.
statusquerynoOnly deliveries in this state.
patientIdquerynoOnly events about this patient: its Signals id, as the payload's patient.
subscriberIdquerynoOnly this subscriber's deliveries, by Signals id or clientId. A subscriber may name only itself.

Responses

StatusMeaning
200One page of events.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber.
404subscriberId names no subscriber in this tenant.
422A query parameter failed validation.

Response body

FieldTypeRequiredDescription
itemsEventDocumentSchema[]yes
nextCursorstring | nullyesOpaque 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

List 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

NameInRequiredDescription
idpathyesThe delivery's id, an item's id in GET /api/events.

Responses

StatusMeaning
200The attempts.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, 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.
404No such delivery in this tenant.

Response body

FieldTypeRequiredDescription
itemsAttemptDocumentSchema[]yesOldest first, at most 100.

POST /api/events/redeliver

Redeliver 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

NameInRequiredDescription
statusquerynoThe deliveries to send again: failed (the default), expired, held or delivered.
sincequeryyesOnly events queued at or after this time. Required, so a replay is always bounded.
subscriberIdquerynoOnly this subscriber's deliveries, by Signals id or clientId. A subscriber may name only itself.

Responses

StatusMeaning
202Queued: how many deliveries will be sent again.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, but the client's role does not permit this, or it is not attached to the patient. Or: A SUBSCRIBER named another subscriber.
404subscriberId names no subscriber in this tenant.
422A query parameter failed validation, or since is missing.

Response body

FieldTypeRequiredDescription
queuednumberyesDeliveries queued to be sent again.

POST /api/events/{id}/redeliver

Redeliver 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

NameInRequiredDescription
idpathyesThe delivery's id, an item's id in GET /api/events.

Responses

StatusMeaning
202Queued.
401Missing, malformed or unrecognised Basic credentials.
403Authenticated, 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.
404No such delivery in this tenant.
409The endpoint is disabled, or the delivery is being sent right now.

Response body

FieldTypeRequiredDescription
queuednumberyesDeliveries queued to be sent again.

Did this page help you?