agency-board

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

Change a webhook, or pause and resume it.

Санҷиши ҳаққоният

Kalitи API-ро ҳамчун token-и bearer фиристед. Ин нуқтаи ниҳоӣ дар мушаххасот иҷозати мушаххасеро нишон намедиҳад, бинобар ин ба калиди худ ҳадди ақали заруриро диҳед ва ба ҷои тахмин кардан, ҷавобро санҷед.

Ин нуқтаи поёнӣ ягон рақами мушаххаси созмонро талаб намекунад. Калиди шумо аллакай созмонеро, ки ба он тааллуқ дорад, муайян мекунад ва ҷавоб ба он маҳдуд карда мешавад.

Санҷидан

Ҳар чизро дар қаavски кунҷӣ бо қиматҳои худ ва ҷойи нигоҳдорандаи калидро бо калима аз панели идоракунии худ иваз кунед.

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> }'

Воarid шудаед? Консоли 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}