GET /v3/callbacks/deliveries/{id}
One delivery of the organization with its payload and every attempt (n, at, duration_ms, http_status, error_class, remote_ip, response_excerpt), oldest first. Another organization's delivery is 404. 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 |
|---|---|---|---|---|---|
id | path | string | yes | The delivery's id (dlv_ and 24 hex digits). |
Responses
| Status | Body | Description |
|---|---|---|
200 | CallbackDeliveryDetail (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 CallbackDeliveryDetail object.
| Field | Type | Required | Description |
|---|---|---|---|
accession | string | null | yes | The filing's accession number, for filing events. |
attempt_count | integer | yes | Attempts made so far; a manual retry or a replay continues the count. |
billed_bytes | integer | yes | The payload bytes billed: the payload size once the endpoint answered 2xx, else 0. Failed attempts, test events and endpoint verification are not billed. |
created_at | date-time (RFC 3339, UTC) | yes | |
delivered_at | date-time (RFC 3339, UTC) | null | yes | |
endpoint_id | string | yes | cbe_ and 24 hex digits. |
held_reason | string | null | yes | Only while state is held. One of: quota_exceeded, plan_required, endpoint_disabled, endpoint_unverified, digest, null. |
id | string | yes | dlv_ and 24 hex digits. |
last_attempt_at | date-time (RFC 3339, UTC) | null | yes | When the newest attempt was made; null before the first. |
last_error | string | null | yes | Why the last attempt failed (an error class such as timeout, or gone, quota_exceeded, plan_required, hold_expired, endpoint_inactive, superseded: a verification challenge replaced by a newer one before it was sent). |
last_status | integer | null | yes | The HTTP status of the last attempt that got one. |
next_attempt_at | date-time (RFC 3339, UTC) | null | yes | When the next attempt is due; only while state is pending. |
state | string | yes | pending: waiting for its next attempt. held: waiting for a condition (held_reason). delivering: an attempt is in flight. delivered: the endpoint answered 2xx. failed: every attempt failed, or the endpoint answered 410, or a hold ran out (last_error says which). dropped: the endpoint was inactive or the hold on an unverified or disabled endpoint ran out, or (a verification) a newer challenge replaced it. One of: pending, held, delivering, delivered, failed, dropped. |
subscription_id | string | null | yes | sub_ and 24 hex digits; null for an event that belongs to no subscription. |
type | string | yes | The event type, for example filing.new. |
attempts | array of CallbackAttempt | yes | Every attempt, oldest first; empty before the first. |
payload | object | yes | The event as sent, the body of the request. |
Example request
curl -sS -H "Authorization: Bearer $SECBLAST_API_KEY" \
'https://api.secblast.com/v3/callbacks/deliveries/dlv_0123456789abcdef01234567'Open this route in the console
More in Webhooks (API: callbacks)
Previous: GET /v3/callbacks/deliveries · Next: POST /v3/callbacks/deliveries/{id}/retry
Markdown version: /docs/reference/get-callbacks-deliveries-id.md