← Back to schema index

`WebhookDelivery`

JSON:API resource for a webhook delivery, with receiver, attempt, response, and status.

ExtendsJsonApiResourceBase

Properties

Field	Type	Description
`type`*	`string`	JSON:API resource type. Always `webhook_delivery`.
`id`*	`string`	Auto-increment delivery identifier.
`attributes`*	`object`	Webhook delivery data (receiver endpoint, attempt, response, and status).
`endpoint_id`*	`string (uuid)`	Unique identifier of the webhook endpoint (UUID v4) that originated this delivery.
`endpoint_url`	`string`	Receiver endpoint URL. Only present on the cross-endpoint list (`GET /v1/webhooks/deliveries`).
`event_type`*	`string`	Event type that produced the delivery. Determines the shape of the HMAC-signed body the receiver gets. `test` marks the synthetic deliveries from the test send.
`validation_id`*	`string \| null`	Unique identifier of the associated validation (UUID v4) when the event is `validation.*`. `null` for any other event.
`response_status`*	`integer \| null`	HTTP status code the receiver answered with. `null` when the delivery never completed a request (timeout or SSRF block).
`response_body`*	`string \| null`	Receiver response body, truncated to 500 characters.
`response_time_ms`*	`integer \| null`	Delivery request duration, in milliseconds.
`attempt`*	`integer`	Attempt number. `1` is the first send; higher values are retries.
`status`*	`string`	Current delivery status. `pending`: Not delivered yet; `retrying`: Deferred by the outbound limit and Messenger will retry it; `success`: Delivered; `failed`: The latest attempt failed; Messenger can schedule another one for a recoverable failure.
`next_retry_at`*	`TimestampUTC \| null`	Date and time of the next persisted retry, in ISO 8601 UTC. `null` when no date is stored; retries scheduled by Messenger do not persist this date on the delivery.
`error_message`*	`string \| null`	Transport or delivery-block error detail. `null` when no error detail is available, including when the receiver answered with a non-`2xx` status.
`created_at`*	`string (date-time)`	ISO 8601 timestamp in UTC with an explicit `Z` suffix; for example, `"2026-05-01T05:14:38Z"`. The `_at`, `_end`, `_start`, and `_date` fields follow this format. `meta.datetime` describes the same contract in the response.

Used in operations

GET /v1/webhooks/{id}/deliveries
GET /v1/webhooks/deliveries