Skip to content

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

NameInTypeRequiredDefaultDescription
endpoint_idquerystringnoOnly deliveries to this endpoint (cbe_ and 24 hex digits).
subscription_idquerystringnoOnly deliveries of this subscription (sub_ and 24 hex digits).
statequerystringnoOnly deliveries in this state. One of: pending, held, delivering, delivered, failed, dropped.
typequerystringnoOnly this event type, for example filing.new.
accessionquerystringnoOnly deliveries about this filing (0000000000-00-000000 or 18 digits).
fromquerystringnocreated_at at or after this time (YYYY-MM-DDTHH:MM:SSZ, or YYYY-MM-DD for midnight UTC).
toquerystringnocreated_at before this time (same forms).
cursorquerystringnoOpaque cursor from a previous page's next_cursor (GET).
limitqueryintegerno20Page size, 1..100.

Responses

StatusBodyDescription
200CallbackDeliveryList (application/json)OK
400Problem (application/problem+json)Invalid or unknown parameter.
401Problem (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).
403Problem (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).
404Problem (application/problem+json)Not found.
503Problem (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).
defaultProblem (application/problem+json)Any other error (405, 500, 504).

Response body

A 200 carries a CallbackDeliveryList object.

FieldTypeRequiredDescription
dataarray of CallbackDeliveryyes
next_cursorstring | nullyesPass it as cursor for the next page; null on the last page.

Example request

Shell
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