agency-board

POST `/v1/agency/boards/{boardId}/webhooks`

Add an outbound webhook.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "url": <string> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

HTTPS only. We mint the signing secret and return it **once, in this response**. There is no endpoint that can read it back, so keep it — rotate to get a new one. Deliveries are signed `X-Zinn-Signature: sha256=<hmac over "<timestamp>.<body>">` with `X-Zinn-Timestamp`, `X-Zinn-Delivery` and `X-Zinn-Event` beside them. The timestamp is bound INTO the signature so a captured request cannot be replayed for ever, and so a receiver cannot be tricked about which timestamp it was.

Parametry

Název	Typ	Požadováno	Co to je
`boardId (path)`	`Uuid`	Ano	Project board ID (UUIDv7).

Tělo požadavku

Název	Typ	Požadováno	Co to je
`name`	`string`	Ano	—
`url`	`string`	Ano	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	Ne	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	Ne	—

Odpověď

Název	Typ	Požadováno	Co to je
`id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ano	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ano	—
`url`	`string`	Ano	—
`events`	`string[]`	Ne	—
`status`	`BoardAutomationStatus`	Ano	`suspended` means WE paused it after repeated failure and it carries a reason the customer has not read. It is a third state rather than a reuse of `disabled`, because collapsin…
`has_secret`	`boolean`	Ano	Whether a signing secret is stored. The secret itself is in Vault and is returned only by create and rotate; no endpoint can read it back.
`consecutive_failures`	`integer`	Ne	—
`suspended_reason`	`string`	Ne	Why we paused this webhook, in authored copy from a closed table — never an exception from our own code. It distinguishes your endpoint refusing a delivery, your endpoint being…
`suspended_at`	`string`	Ne	—
`last_delivered_at`	`string`	Ne	—
`last_failed_at`	`string`	Ne	—
`created_at`	`string`	Ne	—
`secret`	`string`	Ano	Shown ONCE, here. Store it now; rotate to get a new one.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/webhooks