GET /v3/callbacks/deliveries
The organization's webhook deliveries, newest first (created_at, then id), with the attempt count, the last status and error, when the next attempt is due (only while pending) and the bytes billed. Filters: endpoint_id, subscription_id, state, type, accession, from (inclusive) and to (exclusive) on created_at. An endpoint_id or subscription_id that is not the organization's is 404. Deliveries are kept 30 days after their final state. 503 callbacks_unavailable while this server has no callback key file or its database lacks the callback tables.
API key: required. See Authentication.
Group: Webhooks (API: callbacks)
Parameters
| Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
endpoint_id | query | string | no | Only deliveries to this endpoint (cbe_ and 24 hex digits). | |
subscription_id | query | string | no | Only deliveries of this subscription (sub_ and 24 hex digits). | |
state | query | string | no | Only deliveries in this state. One of: pending, held, delivering, delivered, failed, dropped. | |
type | query | string | no | Only this event type, for example filing.new. | |
accession | query | string | no | Only deliveries about this filing (0000000000-00-000000 or 18 digits). | |
from | query | string | no | created_at at or after this time (YYYY-MM-DDTHH:MM:SSZ, or YYYY-MM-DD for midnight UTC). | |
to | query | string | no | created_at before this time (same forms). | |
cursor | query | string | no | Opaque cursor from a previous page's next_cursor (GET). | |
limit | query | integer | no | 20 | Page size, 1..100. |
Responses
| Status | Body | Description |
|---|---|---|
200 | CallbackDeliveryList (application/json) | OK |
400 | Problem (application/problem+json) | Invalid or unknown parameter. |
401 | Problem (application/problem+json) | Missing, invalid or inactive API key (code unauthorized), or a refused access token (code invalid_token: malformed, unknown key, bad signature, expired, wrong issuer or audience, revoked grant). WWW-Authenticate names the protected-resource metadata (RFC 9728). |
403 | Problem (application/problem+json) | The credential's scope does not cover this route (code forbidden), or the organization's plan has no callbacks (code plan_required). |
404 | Problem (application/problem+json) | Not found. |
503 | Problem (application/problem+json) | Callbacks are not available: this server has no callback key file or its database lacks the callback tables (code callbacks_unavailable); too many callback URLs are being checked at once (code db_unavailable, reason resolver_busy, Retry-After 1); or the database is unavailable (code db_unavailable). |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 200 carries a CallbackDeliveryList object.
| Field | Type | Required | Description |
|---|---|---|---|
data | array of CallbackDelivery | yes | |
next_cursor | string | null | yes | Pass it as cursor for the next page; null on the last page. |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/callbacks/deliveries'Open this route in the console
More in Webhooks (API: callbacks)
Next: GET /v3/callbacks/deliveries/{id}
Markdown version: /docs/reference/get-callbacks-deliveries.md