Skip to main content
One delivery and every attempt made
Preview. This operation is not served yet: it is part of the released contract (version 1.0.0). Build against a mock of the contract until the sandbox serves it; see Testing: mock and sandbox.

Authorizations

Authorization
string
header
required

A key starts with gbd_live_ (production) or gbd_test_ (sandbox) and ends in a CRC32 checksum of its secret part, so a mistyped or truncated key is refused before any lookup, as is a key of the other environment. The prefix is registered with public secret scanners (GitHub secret scanning, TruffleHog, GitGuardian): a key found in a public repository is revoked at once and your technical contact is told. Gridbeds stores only a hash of each key. One partner may hold two keys per environment during a rotation. Operations list the scopes they need; the scopes are OAuth 2.0 scope tokens, so short-lived access tokens from a client-credentials grant can be offered later beside keys, with the same scopes and no change to any operation.

Path Parameters

webhook_id
string
required
Pattern: ^whk_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"whk_3fksgepbgj9yqv8wccdx8sxs8v"

delivery_id
string
required
Pattern: ^dlv_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"dlv_2bq8x0vmh47m9scr3d1k6pz0te"

Response

The delivery.

id
string
required
Pattern: ^dlv_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example:

"dlv_2bq8x0vmh47m9scr3d1k6pz0te"

event_id
string
required

Opaque. Ordered within your channel; do not parse.

Pattern: ^evt_(test_)?[0-9a-hjkmnp-tv-z]{13}$
Example:

"evt_00000000000ab"

type
enum<string>
required

Open enum.

Available options:
location.created,
location.updated,
location.deleted,
owner.created,
owner.updated,
owner.deleted,
property.created,
property.updated,
property.deleted,
property.distributed,
property.withdrawn,
availability.updated
state
enum<string>
required

Open enum. A delivery is a log record, not a resource: it has a state rather than the resource status, and is pruned with the log after 35 days.

Available options:
pending,
delivered,
failed,
cancelled
attempts
integer
required
Required range: x >= 0
created_at
string<date-time>
required
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Example:

"2026-10-16T09:30:00Z"

attempts_log
object[]
required
next_attempt_at
string<date-time> | null
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Example:

"2026-10-16T09:30:00Z"

last_response_status
integer | null
last_error
enum<string> | null

Open enum.

Available options:
timeout,
dns_failure,
connection_refused,
tls_error,
connection_failed,
blocked_unsafe_target,
http_error,
outbound_channel_closed,
partner_not_entitled,
endpoint_suspended,
endpoint_failing
delivered_at
string<date-time> | null
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
Example:

"2026-10-16T09:30:00Z"