# List webhooks

List webhooks is a read in the HeadHoncho API. The addresses this key asked us to call when jobs change, with the kinds of change each wants and whether it is paused.

Page: https://headhoncho.app/docs/api/list_webhooks | 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 **List webhooks**, HeadHoncho API v1. It is a read, sent to the base address `https://api.headhoncho.app`.

`GET /api/v1/webhooks`

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

Send your key as `Authorization: Bearer hh_live_...`. See [API keys](https://headhoncho.app/docs/api/keys).

## Parameters

This call takes no parameters.

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

items, one webhook each: id, name, url, kinds (event names from the Event catalog), companies and all_companies, secret_hint (the last four characters of the signing secret, never the secret), paused with paused_reason, created_by and created_at. count is how many.

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[].name` | text | The name, as the app shows it. |
| `items[].url` | text | The link. |
| `items[].kinds` | list of text | The kinds. |
| `items[].companies` | list | The companies. |
| `items[].all_companies` | true or false | The all companies. |
| `items[].secret_hint` | text | The secret hint. |
| `items[].paused` | true or false | The paused. |
| `items[].paused_reason` | text | The paused reason. |
| `items[].created_by` | text | The created by. |
| `items[].created_at` | time (ISO 8601, with offset) | When it was created. Carries its offset from UTC; `Z` is UTC. |
| `count` | whole number | How many match in all, across every page. |

## Only this key's

A key sees the webhooks it made. Webhooks made by another key are not listed, even in the same workspace.

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

- [Get webhook](https://headhoncho.app/docs/api/get_webhook): One webhook: its address, the kinds of change it wants, its companies, and whether it is paused and why.
- [List webhook deliveries](https://headhoncho.app/docs/api/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](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
{
  "items": [
    {
      "id": "whk_6d21",
      "name": "Zapier, new jobs",
      "url": "https://hooks.zapier.com/hooks/catch/123456/abcdef/",
      "kinds": [
        "job.created",
        "job.status_changed"
      ],
      "companies": [],
      "all_companies": true,
      "secret_hint": "9fQd",
      "paused": false,
      "paused_reason": "",
      "created_by": "Ariel T.",
      "created_at": "2026-10-27T14:02:11Z"
    }
  ],
  "count": 1
}
```

### cURL

```bash
curl "https://api.headhoncho.app/api/v1/webhooks" \
  -H "Authorization: Bearer hh_live_..."
```

### Python

```python
import requests

response = requests.get(
    "https://api.headhoncho.app/api/v1/webhooks",
    headers={"Authorization": "Bearer hh_live_..."},
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/webhooks", {
  headers: { Authorization: "Bearer hh_live_..." },
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: list_webhooks
Arguments: none
Access: read on Company settings
Hints: readOnly=true, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, list webhooks."
```