agency-board
POST /v1/agency/boards/{boardId}/webhooks
Add an outbound webhook.
Pengesahan
Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.
Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.
Cuba
Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.
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> }'Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API
Butiran
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.
Parameter
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
boardId (path) | Uuid | Ya | Project board ID (UUIDv7). |
Badan permintaan
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
name | string | Ya | — |
url | string | Ya | HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save. |
events | string[] | Tidak | Empty means every event this board emits. |
status | string<enabled, disabled> | Tidak | — |
Respons
| Nama | Jenis | Diperlukan | Apakah ia |
|---|---|---|---|
id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Ya | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Ya | — |
url | string | Ya | — |
events | string[] | Tidak | — |
status | BoardAutomationStatus | Ya | `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 | Ya | 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 | Tidak | — |
suspended_reason | string | Tidak | 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 | Tidak | — |
last_delivered_at | string | Tidak | — |
last_failed_at | string | Tidak | — |
created_at | string | Tidak | — |
secret | string | Ya | Shown ONCE, here. Store it now; rotate to get a new one. |
Ralat yang boleh dikembalikan oleh titik akhir ini
401 · 403 · 404 · 422