Skip to content
Hayonix

API reference · Schema

WebhookDelivery

  • objectstringrequired

    Always `webhook_delivery`: the type of this object

    One ofwebhook_delivery

  • idstringrequired

    Unique ID (`whd_…`)

    ID with prefix whd_

  • eventstringrequired

    What happened, for example `job.completed`

  • subject_idstringrequired

    ID of the subject

  • urlstringrequired

    The endpoint’s webhook URL the delivery is sent to

  • statusstringrequired

    `pending` (not delivered yet; retried), `delivered` (a 2xx answer), `failed` (every attempt failed)

    One ofpendingdeliveredfailed

  • attemptsintegerrequired

    Attempts made so far

  • max_attemptsintegerrequired

    Attempts made before giving up

  • last_status_codeinteger | nullrequired

    HTTP status of the last attempt (null: no answer)

  • last_errorstring | nullrequired

    Why the last attempt failed (null: it did not)

  • next_attempt_atstring (date-time) | nullrequired

    Time next attempt (ISO 8601, UTC)

  • delivered_atstring (date-time) | nullrequired

    Time delivered (ISO 8601, UTC)

  • attempt_logarray of objectrequired

    Every attempt, oldest first

    Show 5 fields of attempt_log
    • attemptintegerrequired

      Attempt number, from 1

    • atstringrequired

      When it was made (ISO 8601, UTC)

    • status_codeinteger | nullrequired

      HTTP status answered (null: no answer)

    • errorstring | nullrequired

      Why it failed (null: it did not)

    • duration_msintegerrequired

      Time to answer, in milliseconds

  • created_atstring (date-time)required

    When it was created (ISO 8601, UTC)

Example
{
  "object": "webhook_delivery",
  "id": "whd_01jc5zq4m8k3v6x9t2w7r0b1e4",
  "event": "string",
  "subject_id": "string",
  "url": "string",
  "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",
  "attempt_log": [
    {
      "attempt": 1,
      "at": "string",
      "status_code": 1,
      "error": "string",
      "duration_ms": 1
    }
  ],
  "created_at": "2026-01-01T00:00:00.000Z"
}

Used by