Skip to content
Hayonix

API reference · Webhooks

Get a delivery with its payload and attempt log

GET/v1/webhooks/{webhook_id}/deliveries/{delivery_id}
API keywebhook:readProject
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

Headers
HeaderRequiredDescription
AuthorizationyesBearer and your API key. The key implies its project.
X-Project-Idsession onlyThe project to act in, for console sessions. Requests with an API key leave it out.

Path parameters

  • webhook_idstringrequired

    ID of the webhook

    ID with prefix whk_

  • delivery_idstringrequired

    ID of the delivery

    ID with prefix whd_

Response

200 WebhookEventDeliveryDetail — The delivery

  • objectstringrequired

    Always `webhook_delivery`: the type of this object

    One ofwebhook_delivery

  • idstringrequired

    Unique ID (`whd_…`)

    ID with prefix whd_

  • webhook_idstringrequired

    ID of the webhook

    ID with prefix whk_

  • event_idstringrequired

    The event (`evt_…`), sent as `Webhook-Id`

  • event_typestringrequired

    Type 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 ofpendingdeliveredfailed

  • attemptsintegerrequired

    Attempts made so far

  • max_attemptsintegerrequired

    Attempts allowed before the delivery is marked `failed` (retries spread over about a day)

  • last_status_codeinteger | nullrequired

    HTTP status of the latest attempt; null before any attempt or when no response arrived

  • last_errorstring | nullrequired

    Why the latest attempt failed; null when it succeeded or none has been made

  • next_attempt_atstring (date-time) | nullrequired

    Time next attempt (ISO 8601, UTC)

  • delivered_atstring (date-time) | nullrequired

    Time delivered (ISO 8601, UTC)

  • redelivery_ofstring | nullrequired

    The delivery this one re-sends (`whd_…`); null for an original delivery

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

  • payloadobjectrequired

    The body that is sent

  • attempt_logarray of objectrequired

    Every attempt so far, oldest first

    Show 7 fields of attempt_log
    • attemptintegerrequired

      Attempt number, from 1

    • atstring (date-time)required

      When the attempt was made (ISO 8601, UTC)

    • urlstring | nullrequired

      The address it was sent to (the destination’s URL at the time); null if not recorded

    • status_codeinteger | nullrequired

      HTTP status your endpoint answered with; null when no response arrived

    • errorstring | nullrequired

      Why the attempt failed (for example a timeout or a non-2xx status); null when it succeeded

    • duration_msinteger | nullrequired

      How long the attempt took, in milliseconds

    • response_excerptstring | nullrequired

      The first 1024 bytes of the response body

Example response
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:

Errors
StatusTypeWhen
400invalid_request_errorA parameter or body field is missing or not allowed; param names it.
401authentication_errorThe key or session is missing, revoked or expired.
403permission_errorThe credential lacks the permission this needs, or the organization is suspended.
404not_found_errorNo such resource in this project (an ID from another project is answered the same way).
429rate_limit_error rate_limitedToo many requests; retry after retry-after seconds.