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