agency-board
POST /v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate
Mint a new signing secret.
Autenticação
Envie uma chave de API como um token bearer. Este endpoint não especifica uma permissão específica na documentação, portanto, conceda à sua chave o mínimo necessário e verifique a resposta em vez de assumir.
Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.
Experimente
Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate \
-H "Authorization: Bearer zdk_live_…"Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API
Detalhes
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.
Parâmetros
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
boardId (path) | Uuid | Sim | Project board ID (UUIDv7). |
webhookId (path) | Uuid | Sim | Outbound webhook subscription ID (UUIDv7). |
Resposta
| Nome | Tipo | Obrigatório | O que é |
|---|---|---|---|
id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Sim | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Sim | — |
url | string | Sim | — |
events | string[] | Não | — |
status | BoardAutomationStatus | Sim | `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 | Sim | 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 | Não | — |
suspended_reason | string | Não | 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 | Não | — |
last_delivered_at | string | Não | — |
last_failed_at | string | Não | — |
created_at | string | Não | — |
secret | string | Sim | Shown ONCE, here. Store it now; rotate to get a new one. |
Erros que este endpoint pode retornar
401 · 403 · 404 · 422