# Add webhook

Add webhook is a command in the HeadHoncho API. Give us an address and the kinds of change you want. We call it for each change, signed, and retry what fails. The signing secret is shown once.

Page: https://headhoncho.app/docs/api/add_webhook | Part of the HeadHoncho API docs: https://headhoncho.app/docs/api | Machine-readable: https://headhoncho.app/docs/api/openapi.json | Everything in one file: https://headhoncho.app/docs/api/llms-full.txt

## The request

Reference for **Add webhook**, HeadHoncho API v1. It is a command, sent to the base address `https://api.headhoncho.app`.

`POST /api/v1/commands/add-webhook`

The key needs the **Company settings** area at **do**. An answered call costs 1 credit; a refusal costs nothing. See [credits](https://headhoncho.app/docs/api/errors#credits).

It runs the app's own command `add-webhook`. Send an `Idempotency-Key` header with every call: the same key with the same body returns the first answer and runs nothing twice. See [the model](https://headhoncho.app/docs/api/model#idempotency).

## Parameters

| Name | Kind | Required | Description | Example |
| --- | --- | --- | --- | --- |
| `url` | text, in the JSON body | Yes | Where to send changes. https only, and a public address: no private network, no redirects followed. | `https://example.com/hooks/headhoncho` |
| `kinds` | text, in the JSON body | Yes | The kinds of change to send, comma separated, from the Event catalog. | `job.created,job.status_changed` |
| `name` | text, in the JSON body | No | What to call it. Default: the address's host. | `Zapier, new jobs` |
| `company_ids` | text, in the JSON body | No | Limit it to these companies, comma separated. Default: every company this key reaches. | `cmp_14f5` |

## 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.

Paste your key on the web page and it fills a cURL line and a fetch line with your key and the example values. The page never sends the key anywhere. The same lines with a placeholder key are under Examples below.

## What comes back

accepted, position, webhook_id, name, url, kinds, company_ids, secret_hint and secret: the signing secret, shown this once. Changes made from now on are sent; the past is not.

It never deletes anything. It changes only what the command names, and it writes the change to the job's history with who asked for it.

## 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 |
| --- | --- | --- |
| `accepted` | true or false | True when the command ran. A command that cannot run is an error instead. |
| `position` | whole number | Where the change landed in the event log. Pass it as `after` on a read to see your own write. |
| `webhook_id` | id (text) | The id of the webhook. |
| `name` | text | The name, as the app shows it. |
| `url` | text | The link. |
| `kinds` | list of text | The kinds. |
| `company_ids` | list | The company ids. |
| `secret_hint` | text | The secret hint. |
| `secret` | text | The secret. |

## Every plan

Webhooks come with every plan, Free included, like keys. A plan that has none refuses the call with plan_limit.

## One credit per change

Each change we deliver costs one credit, however many tries it takes. At zero credits we hold the changes and pause the webhook; it resumes by itself when credits are back.

## Save the secret

It is the only time we show it. Lose it and use Change a webhook with rotate_secret.

## Errors that apply

| Code | Status | What it means |
| --- | --- | --- |
| [`missing_key`](https://headhoncho.app/docs/api/errors#missing_key) | 401 | Send your key as Authorization: Bearer hh_live_... |
| [`unknown_key`](https://headhoncho.app/docs/api/errors#unknown_key) | 401 | That key is not one we issued, or it was revoked. |
| [`no_access`](https://headhoncho.app/docs/api/errors#no_access) | 403 | This credential does not reach that. Ask the person who made it for access. |
| [`read_only`](https://headhoncho.app/docs/api/errors#read_only) | 403 | This credential may read this area but not change it. |
| [`invalid`](https://headhoncho.app/docs/api/errors#invalid) | 422 | Some fields were refused. See fields. |
| [`missing_idempotency_key`](https://headhoncho.app/docs/api/errors#missing_idempotency_key) | 400 | Send an Idempotency-Key header on every command. |
| [`idempotency_mismatch`](https://headhoncho.app/docs/api/errors#idempotency_mismatch) | 409 | This Idempotency-Key was used with a different body. |
| [`idempotency_in_progress`](https://headhoncho.app/docs/api/errors#idempotency_in_progress) | 409 | A command with this Idempotency-Key is still running. Wait a moment and send it again. |
| [`no_credits`](https://headhoncho.app/docs/api/errors#no_credits) | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |

## Related

- [Change webhook](https://headhoncho.app/docs/api/change_webhook): Rename a webhook, move it to another address, change its kinds or companies, pause or resume it, or replace its secret. Send only what changes.
- [Remove webhook](https://headhoncho.app/docs/api/remove_webhook): Stop calling an address for good. Its past deliveries stay readable.
- [Send webhook test](https://headhoncho.app/docs/api/send_webhook_test): Send a signed test event to one webhook now and say what the address answered. It is not retried and costs no delivery credit.
- [Redeliver webhook](https://headhoncho.app/docs/api/redeliver_webhook): Send one delivery again, from a webhook's list of deliveries. It goes out within a minute. A change already paid for is not paid for twice.
- The same records in the app: [Settings](https://headhoncho.app/docs/settings).
- How the API fits together: [the model](https://headhoncho.app/docs/api/model), [API keys](https://headhoncho.app/docs/api/keys), [errors](https://headhoncho.app/docs/api/errors) and [the MCP server](https://headhoncho.app/docs/api/mcp).

## Examples

### Answer

```json
{
  "accepted": true,
  "position": 88701,
  "webhook_id": "whk_6d21",
  "name": "Zapier, new jobs",
  "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
  "kinds": [
    "job.created",
    "job.status_changed"
  ],
  "company_ids": [],
  "secret_hint": "9fQd",
  "secret": "whsec_Kq3m...9fQd"
}
```

### cURL

```bash
curl -X POST "https://api.headhoncho.app/api/v1/commands/add-webhook" \
  -H "Authorization: Bearer hh_live_..." \
  -H "Idempotency-Key: 6f1d2c9e-1b7a-4c1e-9a52-0d3f8e4b7a10" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/hooks/headhoncho",
  "kinds": "job.created,job.status_changed",
  "name": "Zapier, new jobs",
  "company_ids": "cmp_14f5"
}'
```

### Python

```python
import requests
import uuid

response = requests.post(
    "https://api.headhoncho.app/api/v1/commands/add-webhook",
    headers={
        "Authorization": "Bearer hh_live_...",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "url": "https://example.com/hooks/headhoncho",
        "kinds": "job.created,job.status_changed",
        "name": "Zapier, new jobs",
        "company_ids": "cmp_14f5",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/commands/add-webhook", {
  method: "POST",
  headers: {
    Authorization: "Bearer hh_live_...",
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "url": "https://example.com/hooks/headhoncho",
    "kinds": "job.created,job.status_changed",
    "name": "Zapier, new jobs",
    "company_ids": "cmp_14f5"
  }),
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: add_webhook
Arguments: url (text, required), kinds (text, required), name (text, optional), company_ids (text, optional)
Access: do on Company settings
Hints: readOnly=false, destructive=false, idempotent=false, openWorld=false
Try asking: "Using HeadHoncho, add webhook with url https://example.com/hooks/headhoncho and kinds job.created,job.status_changed and name Zapier, new jobs."
```