v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
WebhookRequest

List Webhook Requests

get/partner/webhook_requests

Query parameters

limitinteger

Allows limiting the number of webhook requests returned.

offsetinteger

Allows offsetting the start of the returned page.

status'pending' | 'attempted' | 'delivered' | 'retrying' | 'failed' | 'duplicate' | 'non_requestable'

Filter by delivery status.

event_typestring

Filter by event type (e.g. patient.created).

attemptsinteger

Filter by attempt count.

created_atstring date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

delivered_atstring date-time

Same shape as created_at.

webhook_endpointstring

Filter by webhook endpoint id (whep-…).

Response

Successful response

attemptsstring
created_atstring
delivered_atstring
event_typestring
last_attempted_atstring
last_responsestring
last_status_codestring
payloadstring
statusstring