Skip to content

Reference / Webhooks

List deliveries

GET/api/v1/webhooks/{id}/deliveries

The webhook's deliveries over the last 30 days, newest first: what was sent, how the receiver responded and when the next attempt will be made.

Guide: webhooks →

Scope

  • webhooks:read Read webhooks – the person behind the key must be administrator.

Path parameters

idstringrequired
The webhook's ID.

Query parameters

limitinteger
The maximum number of items in the response (1–100, default 25).at least 1 · at most 100 · default 25
cursorstring
next_cursor from the previous response, for the next page. Omit for the first page.
statusstring
Only deliveries with that status.pendingdeliveredfailed

Response

200 A page of deliveries.

dataarray<object>required
data[].idstringrequired
The delivery's ID (the Qrona-Delivery header).
data[].event_idstringrequired
The event's ID (ID in the body): the same in all webhooks that receive the event.
data[].typestringrequired
The event, or ping for a test.
data[].statusstringrequired
pending: waiting for a (new) attempt · delivered: the receiver responded 2xx · failed: given up.pendingdeliveredfailed
data[].attemptsintegerrequired
data[].response_statusinteger | nullrequired
The receiver's HTTP status on the latest attempt.
data[].errorstring | nullrequired
data[].next_attempt_atstring (time, ISO 8601) | nullrequired
Next attempt.
data[].created_atstring (time, ISO 8601)required
When the event happened.
data[].delivered_atstring (time, ISO 8601) | nullrequired
When it was delivered.
has_morebooleanrequired
There are more: fetch the next page with cursor=next_cursor.
next_cursorstring | nullrequired
Send as cursor for the next page. null on the last page.

Errors