VocalDocscontracts 1.65.0

List a Webhook subscription's deliveries

GET /v1/webhooks/{webhook_id}/deliveries

PropertyValue
Operationlist_webhook_deliveries
GroupWebhooks
Scopewebhooks:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A metadata read; a subscription and its deliveries hold URLs, ids, codes and measurements, never Call content.
Released in1.63.0
Phase 0 hostServed (the hosted api pins 1.65.0)

Lists the deliveries of the subscription, newest first, optionally by status or event, from the 30-day log (a target; 1.63.0, FR-webhooks-2): what made each, its status, attempts and next attempt, and the last answer's status code, error code and duration. Never a payload.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the webhooks:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/webhooks/whk_.../deliveries" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
webhook_idpathWebhookIdyesThe id of a Webhook subscription: whk_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.
statusqueryWebhookDeliveryStatusnoOnly the deliveries in this status.
event_idqueryEventIdnoOnly the deliveries of this event.

Responses

StatusContent typeShapeError codes
200application/jsonWebhookDeliveryList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is WebhookDeliveryList.

FieldTypeRequiredDescription
dataarray of WebhookDeliveryyesThe deliveries of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes