agency-board
POST /v1/agency/boards/{boardId}/webhooks
Add an outbound webhook.
Uwierzytelnianie
Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.
Ten punkt końcowy nie wymaga identyfikatora organizacji. Twój klucz już identyfikuje organizację, do której należy, a odpowiedź jest do niej ograniczona.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
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> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
boardId (path) | Uuid | Tak | Project board ID (UUIDv7). |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
name | string | Tak | — |
url | string | Tak | HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save. |
events | string[] | Nie | Empty means every event this board emits. |
status | string<enabled, disabled> | Nie | — |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Tak | — |
url | string | Tak | — |
events | string[] | Nie | — |
status | BoardAutomationStatus | Tak | `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 | Tak | 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 | Nie | — |
suspended_reason | string | Nie | 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 | Nie | — |
last_delivered_at | string | Nie | — |
last_failed_at | string | Nie | — |
created_at | string | Nie | — |
secret | string | Tak | Shown ONCE, here. Store it now; rotate to get a new one. |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422