Skip to content

CallbackDelivery

One webhook event sent to one endpoint, with its delivery status.

Fields

FieldTypeAlways presentDescription
accessionstring | nullyesFor filing events, the accession number: the SEC's ID for the filing.
attempt_countintegeryesAttempts made so far. A manual retry or a replay adds to this count.
billed_bytesintegeryesBytes billed for this delivery: the payload size once your endpoint answered 2xx, otherwise 0. Failed attempts, test sends, and verifications are not billed.
created_atdate-time (RFC 3339, UTC)yes—
delivered_atdate-time (RFC 3339, UTC) | nullyes—
endpoint_idstringyesEndpoint ID: cbe_ and 24 hex digits.
held_reasonstring | nullyesWhy the delivery is on hold. Set only while state is held. One of: quota_exceeded, plan_required, endpoint_disabled, endpoint_unverified, digest.
idstringyesDelivery ID: dlv_ and 24 hex digits.
last_attempt_atdate-time (RFC 3339, UTC) | nullyesTime of the latest attempt. Null before the first.
last_errorstring | nullyesWhy 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_statusinteger | nullyesThe HTTP status of the latest attempt that got an answer.
next_attempt_atdate-time (RFC 3339, UTC) | nullyesWhen the next attempt is due. Set only while state is pending.
statestringyespending: waiting for the next attempt. held: on hold; held_reason says why. One of: pending, held, delivering, delivered, failed, dropped. More
subscription_idstring | nullyesSubscription ID: sub_ and 24 hex digits. Null when no subscription produced the event.
typestringyesThe event type, such as filing.new.

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

Markdown version: /docs/reference/schemas/callback-delivery.md