agency-board
POST /v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate
Mint a new signing secret.
توثيقِ شناخت
ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔
یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔
آزمائیں
کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/webhooks/{webhookId}/rotate \
-H "Authorization: Bearer zdk_live_…"لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں
تفصیلات
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.
پیرامیٹرز
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
boardId (path) | Uuid | ہاں | Project board ID (UUIDv7). |
webhookId (path) | Uuid | ہاں | Outbound webhook subscription ID (UUIDv7). |
جواب
| نام | قسم | لازمی | یہ کیا ہے |
|---|---|---|---|
id | Uuid | ہاں | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
board_id | Uuid | ہاں | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | ہاں | — |
url | string | ہاں | — |
events | string[] | نہیں | — |
status | BoardAutomationStatus | ہاں | `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 | ہاں | 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 | نہیں | — |
suspended_reason | string | نہیں | 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 | نہیں | — |
last_delivered_at | string | نہیں | — |
last_failed_at | string | نہیں | — |
created_at | string | نہیں | — |
secret | string | ہاں | Shown ONCE, here. Store it now; rotate to get a new one. |
وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے
401 · 403 · 404 · 422