agency-board

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

Add an outbound webhook.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ API-ի դեմ, որպեսզի կարողանաք տեսնել փաստացի պատասխանը: Բացեք այս վերջնակետը API վահանակում

Մանրամասներ

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.

Պարամետրեր

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`boardId (path)`	`Uuid`	Այո	Project board ID (UUIDv7).

Հարցման մարմին

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`name`	`string`	Այո	—
`url`	`string`	Այո	HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save.
`events`	`string[]`	Ոչ	Empty means every event this board emits.
`status`	`string<enabled, disabled>`	Ոչ	—

Պատասխան

Անուն	Տեսակ	Պահանջվում է	Ինչ է դա
`id`	`Uuid`	Այո	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Այո	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Այո	—
`url`	`string`	Այո	—
`events`	`string[]`	Ոչ	—
`status`	`BoardAutomationStatus`	Այո	`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 collapsing…
`has_secret`	`boolean`	Այո	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`	Ոչ	—
`suspended_reason`	`string`	Ոչ	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`	Ոչ	—
`last_delivered_at`	`string`	Ոչ	—
`last_failed_at`	`string`	Ոչ	—
`created_at`	`string`	Ոչ	—
`secret`	`string`	Այո	Shown ONCE, here. Store it now; rotate to get a new one.

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 422

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