HeadHoncho

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.

Read as Markdown

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.

Send your key as Authorization: Bearer hh_live_.... See 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.

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

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.

FieldTypeMeaning
itemslist of objectsThe rows on this page.
items[].idid (text)The id of this record. Ids are opaque text: keep them exactly as given.
items[].nametextThe name, as the app shows it.
items[].urltextThe link.
items[].kindslist of textThe kinds.
items[].companieslistThe companies.
items[].all_companiestrue or falseThe all companies.
items[].secret_hinttextThe secret hint.
items[].pausedtrue or falseThe paused.
items[].paused_reasontextThe paused reason.
items[].created_bytextThe created by.
items[].created_attime (ISO 8601, with offset)When it was created. Carries its offset from UTC; Z is UTC.
countwhole numberHow 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

CodeStatusWhat it means
`missing_key`401Send your key as Authorization: Bearer hh_live_...
`unknown_key`401That key is not one we issued, or it was revoked.
`no_access`403This credential does not reach that. Ask the person who made it for access.
`no_credits`402Out of credits. Top up on Settings › Credits, or turn on auto top-up.