agency-board
PATCH /v1/agency/boards/{boardId}/webhooks/{webhookId}
Change a webhook, or pause and resume it.
身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
此端点不需要组织 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