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, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Не	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422

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