Skip to content
Hayonix

API reference · Webhooks

List a destination’s deliveries, newest first

GET/v1/webhooks/{webhook_id}/deliveries
API keywebhook:readProjectPaginated
TypeScript
client.webhooks.listDeliveries()
Python
client.webhooks.list_deliveries()
CLI
hayonix webhooks deliveries list

One delivery per event sent to this destination (plus redeliveries), with its latest result. Deliveries are kept for 30 days.

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" \
  -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_

Query parameters

  • limitinteger

    1–200, default 50

    1–200

  • cursorstring

    `next_cursor` of the previous page

    up to 200 characters

  • statusstring

    Only deliveries in this state

    One ofpendingdeliveredfailed

  • event_typestring

    Only deliveries of this event type

    up to 100 characters

Response

200 a page of results — A page of deliveries

  • The items of this page.

    Show 14 fields of data
    • 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)

  • next_cursorstring | nullrequired

    Pass as `cursor` for the next page; null on the last page.

Example response
Example response
{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "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.