agency-board

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

Change a webhook, or pause and resume it.

احراز هویت

یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمی‌کند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.

این نقطه پایانی هیچ شناسه سازمانی را دریافت نمی‌کند. کلید شما در حال حاضر سازمان مربوطه را مشخص می‌کند و پاسخ در همان محدوده ارائه می‌شود.

امتحان کنید

هر چیزی را که داخل براکت‌های زاویه‌دار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.

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}