agency-board

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

Add an outbound webhook.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Ova krajnja točka ne prihvaća ID organizacije. Vaš ključ već identificira organizaciju kojoj pripada, a odgovor je ograničen na nju.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`boardId (path)`	`Uuid`	Da	Project board ID (UUIDv7).

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`name`	`string`	Da	—
`url`	`string`	Da	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	—

Odgovor

Naziv	Vrsta	Obavezno	Što je to
`id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`board_id`	`Uuid`	Da	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Da	—
`url`	`string`	Da	—
`events`	`string[]`	Ne	—
`status`	`BoardAutomationStatus`	Da	`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`	Da	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`	Da	Shown ONCE, here. Store it now; rotate to get a new one.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422

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