CallbackDeliveryDetail
Fields
| Field | Type | Always present | Description |
|---|---|---|---|
accession | string | null | yes | For filing events, the accession number: the SEC's ID for the filing. |
attempt_count | integer | yes | Attempts made so far. A manual retry or a replay adds to this count. |
billed_bytes | integer | yes | Bytes billed for this delivery: the payload size once your endpoint answered 2xx, otherwise 0. Failed attempts, test sends, and verifications are not billed. |
created_at | date-time (RFC 3339, UTC) | yes | — |
delivered_at | date-time (RFC 3339, UTC) | null | yes | — |
endpoint_id | string | yes | Endpoint ID: cbe_ and 24 hex digits. |
held_reason | string | null | yes | Why the delivery is on hold. Set only while state is held. One of: quota_exceeded, plan_required, endpoint_disabled, endpoint_unverified, digest. |
id | string | yes | Delivery ID: dlv_ and 24 hex digits. |
last_attempt_at | date-time (RFC 3339, UTC) | null | yes | Time of the latest attempt. Null before the first. |
last_error | string | null | yes | Why the latest attempt failed. Either an error class such as timeout, or one of gone, quota_exceeded, plan_required, hold_expired, endpoint_inactive, superseded, verified_by_paste, and verification_refused. More |
last_status | integer | null | yes | The HTTP status of the latest attempt that got an answer. |
next_attempt_at | date-time (RFC 3339, UTC) | null | yes | When the next attempt is due. Set only while state is pending. |
state | string | yes | pending: waiting for the next attempt. held: on hold; held_reason says why. One of: pending, held, delivering, delivered, failed, dropped. More |
subscription_id | string | null | yes | Subscription ID: sub_ and 24 hex digits. Null when no subscription produced the event. |
type | string | yes | The event type, such as filing.new. |
attempts | array of CallbackAttempt | yes | Every attempt, oldest first. Empty before the first attempt. |
payload | object | yes | The event exactly as sent: the request body. For endpoint.verification, data.challenge is null here. Only your URL sees the challenge. |
Field notes
last_error
superseded means a newer verification challenge replaced this one before it was sent. verified_by_paste means a pasted challenge verified the endpoint, so the retry was not sent. verification_refused means the endpoint answered a verification 2xx without the challenge.
state
delivering: an attempt is under way. delivered: your endpoint answered 2xx. failed: every attempt failed, the endpoint answered 410, or a hold ran out; last_error says which. dropped: the endpoint was inactive, a hold on an unverified or disabled endpoint ran out, or a newer verification challenge replaced this one. A verification is also dropped when a pasted challenge verified the endpoint before its retry.
Used by
- Returned by
GET /v3/callbacks/deliveries/{id}.
Markdown version: /docs/reference/schemas/callback-delivery-detail.md