agency-board

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

Add an outbound webhook.

تصدیق‌هویت

د بیارر ټوکن په توګه یو API کي وسپارئ. دا پای ټکی په مشخصاتو کې کوم ځانګړی اجازه لیک نه بیانوي، نو خپل کیلي ته لږترلږه هغه څه ورکړئ چې ورته اړتیا لري او د فرض کولو پر ځای ځواب وپلټئ.

دا پای نقطه د سازمان هېڅ آی ډي نه اخلي. ستاسو کیلي مخکې تر مخکې هغه سازمان په ګوته کوي چې پورې اړه لري، او ځواب ورته محدود دی.

هڅه وکړئ

د انګلیسي په زاوي پنسونو کې هرڅه د خپلو ارزښتونو سره بدل کړئ، او د کلي ځای لرونکی ستاسو د ډشبورډ د کلي سره.

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 په وړاندې پرمخ وړي ترڅو تاسو وکولی شئ اصلي ځواب وګورئ. دا پای ټکی (endpoint) د 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 collapsin…
`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