agency-board

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

Add an outbound webhook.

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

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 в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в 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