List deliveries
Events sent to this endpoint, newest first, with response code, attempts and latency. Bodies are only on retrieve. Filters match the design: All / Succeeded / Failed and search by event id or type (q).
Error codes: invalid_api_key, parameter_invalid, resource_not_found, scope_missing, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always
our own req_… id. We log your value with the request as client_request_id, so support can find a request by
either id. A longer value is refused with 400 parameter_invalid.
128Path Parameters
Webhook endpoint id.
^whe_[0-9A-HJKMNP-TV-Z]{26}$Query Parameters
Page size, 1–100.
1 <= x <= 100Cursor from the previous page's next_cursor. Returns older items. Don't send with before.
Cursor for the reverse direction: returns the items newer than this one. The page is still sorted newest first;
has_more and next_cursor then continue in the same (newer) direction, so pass next_cursor as before to
keep paging towards the newest items. Don't send with after.
Comma-separated. "Failed" in the design = failed,retrying.
Exact event type.
Event type, <resource>.<event> (e.g. payment.completed). The catalogue is asyncapi/webhooks.yaml and GET /event-types; clients must tolerate new types.
^[a-z_]+(\.[a-z_]+)+$"payment.completed"
Free-text search.
200Only items created at or after this time.
Only items created at or before this time.
Set to total_count to add total_count to the list response.
total_count Response
A page of deliveries.
Cursor page. Domain files compose this with allOf and set data.items.
"list"Items, newest first.
True when another page exists.
Cursor for the next page in the same direction: pass it as after if this page was read with after (or no cursor), as before if it was read with before. Null when has_more is false.
Only when include=total_count was sent.