agency-board

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

Add an outbound webhook.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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> }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`boardId (path)`	`Uuid`	Ndiyo	Project board ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`name`	`string`	Ndiyo	—
`url`	`string`	Ndiyo	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	Hapana	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	Hapana	—

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Ndiyo	—
`url`	`string`	Ndiyo	—
`events`	`string[]`	Hapana	—
`status`	`BoardAutomationStatus`	Ndiyo	`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`	Ndiyo	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`	Hapana	—
`suspended_reason`	`string`	Hapana	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`	Hapana	—
`last_delivered_at`	`string`	Hapana	—
`last_failed_at`	`string`	Hapana	—
`created_at`	`string`	Hapana	—
`secret`	`string`	Ndiyo	Shown ONCE, here. Store it now; rotate to get a new one.

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

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