Change webhook

The request

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

POST /api/v1/commands/change-webhook

The key needs the Company settings area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.

It runs the app's own command change-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.

Parameters

Name	Kind	Required	Description	Example
`webhook_id`	id, in the JSON body	Yes	The webhook, from List webhooks.	`whk_6d21`
`name`	text, in the JSON body	No	A new name.	`Zapier, all jobs`
`url`	text, in the JSON body	No	A new address. The same rules as when adding.	`https://example.com/hooks/v2`
`kinds`	text, in the JSON body	No	The kinds of change, comma separated. They replace the list.	`job.created,job.assigned`
`company_ids`	text, in the JSON body	No	The companies, comma separated. They replace the list; an empty value means every company the key reaches.	`cmp_14f5`
`paused`	boolean, in the JSON body	No	true pauses it, false resumes it. What it missed while paused is sent in order on resume.	`false`
`rotate_secret`	boolean, in the JSON body	No	true replaces the signing secret and shows the new one this once. The old one stops signing at once.	`false`

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 API key webhook_id (required, id) name (optional, text) url (optional, text) kinds (optional, text) company_ids (optional, text) paused (optional, boolean) rotate_secret (optional, boolean)

Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.

What comes back

accepted, position, webhook_id, name, url, kinds, company_ids, paused and, when rotate_secret was true, secret and secret_hint.

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.
`paused`	true or false	The paused.

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.
`read_only`	403	This credential may read this area but not change it.
`not_found`	404	No such record in the companies this credential reaches.
`invalid`	422	Some fields were refused. See fields.
`missing_idempotency_key`	400	Send an Idempotency-Key header on every command.
`idempotency_mismatch`	409	This Idempotency-Key was used with a different body.
`idempotency_in_progress`	409	A command with this Idempotency-Key is still running. Wait a moment and send it again.
`no_credits`	402	Out of credits. Top up on Settings › Credits, or turn on auto top-up.

Add webhook: 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.
Remove webhook: Stop calling an address for good. Its past deliveries stay readable.
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: 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.
How the API fits together: the model, API keys, errors and the MCP server.

Answer cURL Python JavaScript Your AI

{
  "accepted": true,
  "position": 88701,
  "webhook_id": "whk_6d21",
  "name": "Zapier, all jobs",
  "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
  "kinds": [
    "job.created",
    "job.status_changed"
  ],
  "company_ids": [],
  "paused": false
}

curl -X POST "https://api.headhoncho.app/api/v1/commands/change-webhook" \
  -H "Authorization: Bearer hh_live_..." \
  -H "Idempotency-Key: 6f1d2c9e-1b7a-4c1e-9a52-0d3f8e4b7a10" \
  -H "Content-Type: application/json" \
  -d '{
  "webhook_id": "whk_6d21",
  "name": "Zapier, all jobs",
  "url": "https://example.com/hooks/v2",
  "kinds": "job.created,job.assigned",
  "company_ids": "cmp_14f5",
  "paused": false,
  "rotate_secret": false
}'

import requests
import uuid

response = requests.post(
    "https://api.headhoncho.app/api/v1/commands/change-webhook",
    headers={
        "Authorization": "Bearer hh_live_...",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "webhook_id": "whk_6d21",
        "name": "Zapier, all jobs",
        "url": "https://example.com/hooks/v2",
        "kinds": "job.created,job.assigned",
        "company_ids": "cmp_14f5",
        "paused": False,
        "rotate_secret": False,
    },
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.headhoncho.app/api/v1/commands/change-webhook", {
  method: "POST",
  headers: {
    Authorization: "Bearer hh_live_...",
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "webhook_id": "whk_6d21",
    "name": "Zapier, all jobs",
    "url": "https://example.com/hooks/v2",
    "kinds": "job.created,job.assigned",
    "company_ids": "cmp_14f5",
    "paused": false,
    "rotate_secret": false
  }),
});
const data = await response.json();
console.log(data);

Tool: change_webhook
Arguments: webhook_id (id, required), name (text, optional), url (text, optional), kinds (text, optional), company_ids (text, optional), paused (boolean, optional), rotate_secret (boolean, optional)
Access: do on Company settings
Hints: readOnly=false, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, change webhook with webhook_id whk_6d21 and name Zapier, all jobs."