The request
Reference for List webhook deliveries, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/webhooks/{webhook_id}/deliveries
The key needs the Company settings area at read. An answered call costs 1 credit; a refusal costs nothing. See credits.
Send your key as Authorization: Bearer hh_live_.... See API keys.
Parameters
| Name | Kind | Required | Description | Example |
|---|---|---|---|---|
webhook_id | id, in the path | Yes | The webhook, from List webhooks. | whk_6d21 |
status | text, in the query | No | Only deliveries in this state. One of pending, delivered, failed. | failed |
limit | number, in the query | No | 1 to 200. Default 50. | 50 |
Try it with your key
Paste your key and change the values. The box builds the call as a cURL line and a fetch line, ready to copy. It never sends anything itself.
Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.
What comes back
items, one delivery each: id, event_id (the id sent in X-HeadHoncho-Event-Id), event, job, status (pending, delivered or failed), attempts, last_attempt_at, next_attempt_at (when a pending one is tried again), response_code, error, and attempt_log: every try with its number n, at, code (null when nothing answered), ms and error.
It never changes a record. It only reads the companies the key reaches.
Every field in the answer
Types are read from the example answer. Money is a plain number in the company's currency. A time carries its offset from UTC (Z is UTC). Ids are opaque text. A field with no line of its own here has its name spelled out; the common fields mean the same on every page.
| Field | Type | Meaning |
|---|---|---|
items | list of objects | The rows on this page. |
items[].id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
items[].event_id | id (text) | The id of the event. |
items[].event | text | The kind of event, as a code. |
items[].job | object | The job. |
items[].job.id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
items[].job.number | whole number | The number people say out loud, such as the job number. |
items[].status | text | One of pending, delivered, failed. |
items[].attempts | whole number | The attempts. |
items[].last_attempt_at | time (ISO 8601, with offset) | When the last attempt happened. Carries its offset from UTC; Z is UTC. |
items[].next_attempt_at | time or null | When the next attempt happened. |
items[].response_code | whole number | The response code. |
items[].error | text | The error. |
items[].attempt_log | list of objects | The attempt log. |
items[].attempt_log[].n | whole number | The n. |
items[].attempt_log[].at | time (ISO 8601, with offset) | The moment it happened. Carries its offset from UTC; Z is UTC. |
items[].attempt_log[].code | whole number | The code. |
items[].attempt_log[].ms | whole number | The ms. |
items[].attempt_log[].error | text | The error. |
count | whole number | How many match in all, across every page. |
Errors that apply
| Code | Status | What it means |
|---|---|---|
| `missing_key` | 401 | Send your key as Authorization: Bearer hh_live_... |
| `unknown_key` | 401 | That key is not one we issued, or it was revoked. |
| `no_access` | 403 | This credential does not reach that. Ask the person who made it for access. |
| `not_found` | 404 | No such record in the companies this credential reaches. |
| `invalid` | 422 | Some fields were refused. See fields. |
| `no_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- List webhooks: The addresses this key asked us to call when jobs change, with the kinds of change each wants and whether it is paused.
- Get webhook: One webhook: its address, the kinds of change it wants, its companies, and whether it is paused and why.
- The same records in the app: Settings.
- How the API fits together: the model, API keys, errors and the MCP server.