agency-board
PATCH /v1/agency/boards/{boardId}/webhooks/{webhookId}
Change a webhook, or pause and resume it.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
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> }'Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Parameter
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
boardId (path) | Uuid | Oo | Project board ID (UUIDv7). |
webhookId (path) | Uuid | Oo | Outbound webhook subscription ID (UUIDv7). |
Katawan ng kahilingan
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
name | string | Oo | — |
url | string | Oo | HTTPS only. Private and link-local addresses are refused when the socket opens, not when you save. |
events | string[] | Hindi | Empty means every event this board emits. |
status | string<enabled, disabled> | Hindi | — |
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Oo | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Oo | — |
url | string | Oo | — |
events | string[] | Hindi | — |
status | BoardAutomationStatus | Oo | `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 | Oo | 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 | Hindi | — |
suspended_reason | string | Hindi | 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 | Hindi | — |
last_delivered_at | string | Hindi | — |
last_failed_at | string | Hindi | — |
created_at | string | Hindi | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404 · 422