agency-board

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

Add an outbound webhook.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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