API reference · Webhooks
Get a delivery with its payload and attempt log
/v1/webhooks/{webhook_id}/deliveries/{delivery_id}- TypeScript
client.webhooks.getDelivery()- Python
client.webhooks.get_delivery()- CLI
hayonix webhooks deliveries show
Returns the body that is sent and every attempt so far, with the status code, error, duration and the start of your endpoint’s response.
Project API key (Authorization: Bearer sk_…), or a console session. Requires the webhook:read permission (a key's scope, or a role that includes it).
Examples
The samples read API_KEY and API_BASE_URL from the environment (see Setup). Values are examples.
curl -sS "$API_BASE_URL/webhooks/whk_01jc5zq4m8k3v6x9t2w7r0b1e4/deliveries/whd_01jc5zq4m8k3v6x9t2w7r0b1e4" \
-H "Authorization: Bearer $API_KEY"Request
| Header | Required | Description |
|---|---|---|
Authorization | yes | Bearer and your API key. The key implies its project. |
X-Project-Id | session only | The project to act in, for console sessions. Requests with an API key leave it out. |
Path parameters
webhook_idstringrequiredID of the webhook
ID with prefix whk_
delivery_idstringrequiredID of the delivery
ID with prefix whd_
Response
200 WebhookEventDeliveryDetail — The delivery
objectstringrequiredAlways `webhook_delivery`: the type of this object
One of
webhook_deliveryidstringrequiredUnique ID (`whd_…`)
ID with prefix whd_
webhook_idstringrequiredID of the webhook
ID with prefix whk_
event_idstringrequiredThe event (`evt_…`), sent as `Webhook-Id`
event_typestringrequiredType of the event, also sent as `Webhook-Event`
statusstringrequired`pending` (waiting for its next attempt), `delivered` (your endpoint answered 2xx) or `failed` (every attempt failed, or it was given up, for example when the destination was paused)
One of
pendingdeliveredfailedattemptsintegerrequiredAttempts made so far
max_attemptsintegerrequiredAttempts allowed before the delivery is marked `failed` (retries spread over about a day)
last_status_codeinteger | nullrequiredHTTP status of the latest attempt; null before any attempt or when no response arrived
last_errorstring | nullrequiredWhy the latest attempt failed; null when it succeeded or none has been made
next_attempt_atstring (date-time) | nullrequiredTime next attempt (ISO 8601, UTC)
delivered_atstring (date-time) | nullrequiredTime delivered (ISO 8601, UTC)
redelivery_ofstring | nullrequiredThe delivery this one re-sends (`whd_…`); null for an original delivery
created_atstring (date-time)requiredWhen it was created (ISO 8601, UTC)
payloadobjectrequiredThe body that is sent
attempt_logarray of objectrequiredEvery attempt so far, oldest first
ShowHide 7 fields of
attempt_logattemptintegerrequiredAttempt number, from 1
atstring (date-time)requiredWhen the attempt was made (ISO 8601, UTC)
urlstring | nullrequiredThe address it was sent to (the destination’s URL at the time); null if not recorded
status_codeinteger | nullrequiredHTTP status your endpoint answered with; null when no response arrived
errorstring | nullrequiredWhy the attempt failed (for example a timeout or a non-2xx status); null when it succeeded
duration_msinteger | nullrequiredHow long the attempt took, in milliseconds
response_excerptstring | nullrequiredThe first 1024 bytes of the response body
Example response
{
"object": "webhook_delivery",
"id": "whd_01jc5zq4m8k3v6x9t2w7r0b1e4",
"webhook_id": "whk_01jc5zq4m8k3v6x9t2w7r0b1e4",
"event_id": "string",
"event_type": "pod.running",
"status": "pending",
"attempts": 1,
"max_attempts": 1,
"last_status_code": 1,
"last_error": "string",
"next_attempt_at": "2026-01-01T00:00:00.000Z",
"delivered_at": "2026-01-01T00:00:00.000Z",
"redelivery_of": "string",
"created_at": "2026-01-01T00:00:00.000Z",
"payload": {},
"attempt_log": [
{
"attempt": 1,
"at": "2026-01-01T00:00:00.000Z",
"url": "string",
"status_code": 1,
"error": "string",
"duration_ms": 1,
"response_excerpt": "string"
}
]
}Errors
Errors use the standard envelope. What this operation can answer:
| Status | Type | When |
|---|---|---|
400 | invalid_request_error | A parameter or body field is missing or not allowed; param names it. |
401 | authentication_error | The key or session is missing, revoked or expired. |
403 | permission_error | The credential lacks the permission this needs, or the organization is suspended. |
404 | not_found_error | No such resource in this project (an ID from another project is answered the same way). |
429 | rate_limit_error rate_limited | Too many requests; retry after retry-after seconds. |