agency-board

PATCH `/v1/agency/boards/{boardId}/webhooks/{webhookId}`

Change a webhook, or pause and resume it.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.

Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.

Спробувати

Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "url": <string> }'

Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API

Параметри

Назва	Тип	Обов'язкове	Що це таке
`boardId (path)`	`Uuid`	Так	Project board ID (UUIDv7).
`webhookId (path)`	`Uuid`	Так	Outbound webhook subscription 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`	Ні	—

Помилки, які може повертати ця кінцева точка

401 · 403 · 404 · 422

PATCH /v1/agency/boards/{boardId}/webhooks/{webhookId}