agency-board
POST /v1/agency/boards/{boardId}/inbound-endpoints/{endpointId}/rotate
Mint a new secret for an inbound endpoint.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
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}/inbound-endpoints/{endpointId}/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 is unchanged — only the secret the sender signs with. That separation is why a rotation is a one-field edit in the sending system rather than a reconfigure.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
endpointId (path) | Uuid | Yes | Inbound endpoint 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 | — |
endpoint_key | string | Yes | The opaque path segment. Not the board id, and unchanged by a secret rotation. |
url | string | No | The full URL to paste into the sending system. |
signature_scheme | string<zinn, github> | Yes | — |
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 collapsin… |
has_secret | boolean | Yes | — |
request_count | integer | No | — |
rejected_count | integer | No | — |
last_rejection | string | No | Why the last refused request was refused — so "my n8n node says 404" is answerable from this screen rather than from a support ticket. |
last_seen_at | string | No | — |
created_at | string | No | — |
secret | string | Yes | Shown ONCE, here. |
Errors this endpoint can return
401 · 403 · 404 · 422