agency-board
POST /v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate
Mint a new signing secret.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
The URL does not change; only the secret does. Deliveries signed with the old secret stop verifying immediately, so update the receiver in the same sitting.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
webhookId (path) | Uuid | Yes | Outbound webhook subscription ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Yes | — |
url | string | Yes | — |
events | string[] | No | — |
status | BoardAutomationStatus | Yes | 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 collapsing… |
has_secret | boolean | Yes | 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 | No | — |
suspended_reason | string | No | 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 | No | — |
last_delivered_at | string | No | — |
last_failed_at | string | No | — |
created_at | string | No | — |
secret | string | Yes | Shown ONCE, here. Store it now; rotate to get a new one. |
Errors this endpoint can return
401 · 403 · 404 · 422