agency-board

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

Change a webhook, or pause and resume it.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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 консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй 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}