The request
Reference for Get webhook, HeadHoncho API v1. It is a read, sent to the base address https://api.headhoncho.app.
GET /api/v1/webhooks/{webhook_id}
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 |
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
The webhook in the List webhooks shape. paused_reason is by_hand, no_credits (the workspace ran out of credits), failing (the address kept failing) or access_revoked (the key was revoked).
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 |
|---|---|---|
id | id (text) | The id of this record. Ids are opaque text: keep them exactly as given. |
name | text | The name, as the app shows it. |
url | text | The link. |
kinds | list of text | The kinds. |
companies | list | The companies. |
all_companies | true or false | The all companies. |
secret_hint | text | The secret hint. |
paused | true or false | The paused. |
paused_reason | text | The paused reason. |
created_by | text | The created by. |
created_at | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; Z is UTC. |
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.
- List webhook deliveries: The last changes sent to one webhook, newest first, with the answer code and time of every try.
- The same records in the app: Settings.
- How the API fits together: the model, API keys, errors and the MCP server.