agency-board
POST /v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate
Mint a new signing secret.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
boardId (path) | Uuid | Evet | Project board ID (UUIDv7). |
webhookId (path) | Uuid | Evet | Outbound webhook subscription ID (UUIDv7). |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Evet | — |
url | string | Evet | — |
events | string[] | Hayır | — |
status | BoardAutomationStatus | Evet | `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 | Evet | 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 | Hayır | — |
suspended_reason | string | Hayır | 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 | Hayır | — |
last_delivered_at | string | Hayır | — |
last_failed_at | string | Hayır | — |
created_at | string | Hayır | — |
secret | string | Evet | Shown ONCE, here. Store it now; rotate to get a new one. |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404 · 422