List event subscription deliveries
const url = 'https://api.getsitecontrol.com/v1/sites/1/event-subscriptions/1/deliveries?limit=50&order=oldest';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://api.getsitecontrol.com/v1/sites/1/event-subscriptions/1/deliveries?limit=50&order=oldest' \ --header 'Authorization: Bearer <token>'The delivery journal of one event subscription: every request sent or to be sent, from the last 31 days, tests included. Call it to find why a receiver did not get an event; the request and the receiver’s answers are in get_event_subscription_delivery.
Statuses are current ones. Filters combine. While next_cursor is set, pass it as cursor with the same filters and order for the next page. Spends the heavy request limit.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Event subscription id from list_event_subscriptions
Event subscription id from list_event_subscriptions
Query Parameters
Section titled “Query Parameters”Deliveries per page
Deliveries per page
Only deliveries in these statuses; repeat the parameter for several. pending: waiting for the first attempt or a retry, or being sent; succeeded: the receiver answered 2xx, 302 or 303; failed: given up, see outcome; cancelled: dropped before sending because the event subscription was deleted, switched off or saved since, or its URL host changed
Only deliveries in these statuses; repeat the parameter for several. pending: waiting for the first attempt or a retry, or being sent; succeeded: the receiver answered 2xx, 302 or 303; failed: given up, see outcome; cancelled: dropped before sending because the event subscription was deleted, switched off or saved since, or its URL host changed
Only deliveries of this event: the id of the payload (evt_ and 32 hex digits), also event_id of a delivery
Only deliveries of this event: the id of the payload (evt_ and 32 hex digits), also event_id of a delivery
next_cursor of the previous page, with the same filters and order; omit for the first
next_cursor of the previous page, with the same filters and order; omit for the first
Order of the items: oldest first (default) or newest first; asc and desc mean the same
Order of the items: oldest first (default) or newest first; asc and desc mean the same
Responses
Section titled “Responses”object
object
Delivery id, sent as the webhook-id header: the same on every retry, new on a redelivery
id of the event in the payload: the same for every event subscription and every redelivery of the event
Null once the event is purged
True for a delivery of test_event_subscription
Pending: waiting for an attempt or being sent; succeeded: accepted by the
receiver; failed: given up, see outcome; cancelled: dropped before sending
because the event subscription was deleted, switched off or saved since, or
its URL host changed.
How a finished delivery ended. accepted: the receiver answered 2xx, 302 or 303, which is not proof it processed the event; rejected: another 4xx, or 301, 307, 308 and other 3xx (the receiver moved, see the attempt’s location), not retried; gone: 410; retry_exhausted: every retry failed; expired: no time left for a retry; rate_limited: the receiver’s 429 pause ran past the deadline; invalid_request: the request could not be built, e.g. a template failed on the event (last_error says why); private_network_block: the host resolved to a private address; cancelled: see status. More values may appear
Requests sent so far
HTTP status of the last attempt’s answer; null without an answer
What went wrong last, e.g. HTTP 500 or render failed: ...
When the next attempt is due; null once finished
When it finished; null while pending
The delivery this one redelivers
Pass as cursor for the next page; null on the last
{ "items": [ { "status": "pending" } ]}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
Authentication scheme: Bearer
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
event_subscription_not_found: no event subscription with this id on the site; site_not_found: no such site
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
invalid_cursor: the cursor is malformed or was issued for another event subscription, other filters or another order; validation_failed: a parameter is out of range
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds
Seconds until the bucket refills
The documented shape of every error body on the versioned surface.
object
object
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example", "reason": "example", "next": "example", "request_id": "example", "errors": [ { "loc": [ "example" ], "msg": "example", "type": "example" } ], "metadata": {}}Headers
Section titled “Headers”API version the response was produced for
Request id, echoed from the request when valid
Limit of the tightest bucket
Requests left in its window
End of its window, epoch seconds