Skip to navigation

List deliveries

Returns the deliveries of an endpoint, newest first, one page at a time, without the body that was sent or the answer of your server. Filter by status to find deliveries that failed, or by event_type. Deliveries are kept for 30 days after they were created. Read one delivery to see its body. Required scope: webhooks:manage. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Path parameters

endpoint_idstringRequiredformat: "uuid"

Id of the webhook endpoint, as returned when it was created or by GET /webhook-endpoints.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Query parameters

statusenumOptional

Only deliveries in this status. pending: waiting for the next attempt. delivered: your server answered with a 2xx status. failed: every attempt failed and no more will be made. discarded: the feature was switched off before it was sent.

Allowed values:
event_typestringOptional1-60 characters

Only deliveries of this event type, for example call.ended.

limitintegerOptional1-100Defaults to 20
Maximum number of items in the page, from 1 to 100. Default 20.
cursorstringOptional1-400 characters

Opaque cursor from next_cursor of the previous page, to read the next one. Pass it back unchanged, with the same filters; omit it for the first page.

Response

Successful response.
datalist of objects
The items of this page, in the requested order.
has_moreboolean

true if there are more items after this page.

next_cursorstring or null

Pass it as cursor to read the next page; null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error