Webhook 端點
列出 Webhook 端點
列出目前工作區的 Webhook 端點,包含訂閱事件、簽章狀態、狀態與重試政策。
https://api.unifyport.ai/v1/webhook-endpoints支援渠道
呼叫前準備
在伺服器端使用資源所屬工作區的 X-Api-Key,執行範例前替換所有預留位置。
參數從哪裡取得
- account_id
- 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。 取得帳號
請求參數
請求標頭
X-Api-Key工作區 API Key,工作區會由此標頭解析得到。
查詢參數
account_id可選的公開帳號 ID,例如 acc_example。不可為空、僅含空白或重複出現。參數名稱必須精確使用 account_id;大小寫變體回傳 400 invalid_request,不視為省略。列表省略時只回傳工作空間端點;指定時只回傳帳號獨立設定(沒有獨立設定則 data=[],不混入繼承的工作空間設定)。詳情、停用、刪除僅驗證既有帳號歸屬;不符則回傳 400 invalid_request。明確指定的帳號不存在或不屬於目前工作空間時回傳 404 account_not_found (20020)。
minLength: 1 · pattern: \S
請求內容
此介面無需 JSON 請求內容。
如何理解結果
讀取端點歸屬、status、訂閱事件、signing_enabled 與重試策略。查詢成功僅確認設定,不證明事件已投遞。
回應 200 OK
{
"request_id": "<REQUEST_ID>",
"data": [
{
"id": "we_example",
"url": "https://example.com/webhook",
"status": "active",
"subscribed_events": [
"message.received"
],
"signing_enabled": true,
"retry_policy": {
"max_attempts": 3
}
}
]
}
回應內容
idWebhook 端點識別字(we_...)。
account_id帳號獨立端點的公開帳號 ID;工作空間端點省略此欄位,不回傳 null。
minLength: 1
url接收 Webhook 投遞的絕對 HTTP(S) URL;正式環境建議 HTTPS。
format: uri
status端點狀態:active 或 inactive。
enum: active, inactive
subscribed_events[]投遞至此端點的公開標準事件類型;["*"] 表示工作區可接收的公開事件,不包含 provider.raw_event。
signing_enabled當已設定簽章密鑰且投遞會被簽章時為 true。
retry_policyobjectAPI 回傳的重試設定。max_attempts 統計首次投遞後的重試次數,預設 3,範圍 0 到 5。
retry_policyAPI 回傳的重試設定。max_attempts 統計首次投遞後的重試次數,預設 3,範圍 0 到 5。
max_attempts已設定的首次投遞後重試次數,範圍為 0 到 5。
回應
200200 OK
請求成功,回應內容範例如上。
400請求錯誤
請求內容、路徑或參數無效。
401未授權
X-Api-Key 請求標頭缺少或無效。
403禁止存取
請求已識別,但不允許執行此操作。
404找不到資源
找不到請求的資源;請結合 error.code 和目前操作核對。
500伺服器錯誤
服務遇到了未預期的錯誤。
失敗後如何處理
檢查 HTTP 狀態和 error.code/numeric_code,保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果,避免重複操作。 錯誤碼參考
結合目前操作讀取 HTTP 狀態、error.code 和 error.numeric_code。數字碼以字串處理。保留 request_id 排查;它不是冪等鍵或任務識別碼。
- invalid_request · 10000 · 400
檢查 JSON 請求本文與必填欄位。
處理與重試: 按目前操作與渠道條件修正參數後再請求。重複提交相同的無效請求不會解決錯誤。
示意 JSON;message 隨實際原因變化 · 400 · 10000
{ "request_id": "req_example", "error": { "code": "invalid_request", "numeric_code": "10000", "message": "Invalid request parameters" } }- invalid_target_workspace · 11003 · 400
工作區覆寫目標為空或格式無效。移除覆寫請求標頭,改用目標工作區所屬的 API Key。
觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭的請求。
處理與重試: 按目前操作與渠道條件修正參數後再請求。重複提交相同的無效請求不會解決錯誤。
示意 JSON;message 隨實際原因變化 · 400 · 11003
{ "request_id": "req_example", "error": { "code": "invalid_target_workspace", "numeric_code": "11003", "message": "Invalid target workspace" } }- invalid_api_key · 11001 · 401
檢查 API Key 是否正確且已啟用。
處理與重試: 保留 request_id 與結構化錯誤碼,先排查目前操作,再決定下一步。
示意 JSON;message 隨實際原因變化 · 401 · 11001
{ "request_id": "req_example", "error": { "code": "invalid_api_key", "numeric_code": "11001", "message": "Invalid API key" } }- missing_api_key · 11000 · 401
請加入 X-Api-Key 請求標頭。
處理與重試: 保留 request_id 與結構化錯誤碼,先排查目前操作,再決定下一步。
範例 · 401 · 11000
{ "request_id": "req_xxx", "error": { "code": "missing_api_key", "numeric_code": "11000", "message": "Missing X-Api-Key header" } }- workspace_override_forbidden · 11002 · 403
請求嘗試使用此 API Key 無權使用的工作區覆寫。移除覆寫請求標頭,改用目標工作區所屬的 API Key。
觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭的請求。
處理與重試: 保留 request_id 與結構化錯誤碼,先排查目前操作,再決定下一步。
示意 JSON;message 隨實際原因變化 · 403 · 11002
{ "request_id": "req_example", "error": { "code": "workspace_override_forbidden", "numeric_code": "11002", "message": "Workspace override is not allowed" } }- account_not_found · 20020 · 404
核對 account_id,並使用帳號所屬工作區的 X-Api-Key。此工作區下未找到的帳號無法使用目前 Key 存取。
處理與重試: 核對目標識別碼、資源歸屬與目前工作區。不要將已確認缺失或無法存取的目標當作暫時服務故障自動重試。
示意 JSON;message 隨實際原因變化 · 404 · 20020
{ "request_id": "req_example", "error": { "code": "account_not_found", "numeric_code": "20020", "message": "Account not found" } }- target_workspace_not_found · 11004 · 404
覆寫指定的工作區不存在或不可用。核對工作區歸屬,移除覆寫請求標頭並使用目標工作區 API Key;重複請求不會增加存取權限。
觸發條件: 適用於帶有 X-Workspace-Id 工作區覆寫請求標頭的請求。
處理與重試: 核對目標識別碼、資源歸屬與目前工作區。不要將已確認缺失或無法存取的目標當作暫時服務故障自動重試。
示意 JSON;message 隨實際原因變化 · 404 · 11004
{ "request_id": "req_example", "error": { "code": "target_workspace_not_found", "numeric_code": "11004", "message": "Target workspace not found" } }- list_webhook_endpoints_failed · 40000 · 500
列出 Webhook 端點:服務未能產生有效的查詢結果。
處理與重試: 保留 request_id,核對目標識別碼與帳號存取範圍。查明原因後再重試查詢;查詢失敗不等於結果為空或資源不存在。
示意 JSON;message 隨實際原因變化 · 500 · 40000
{ "request_id": "req_example", "error": { "code": "list_webhook_endpoints_failed", "numeric_code": "40000", "message": "Failed to list webhook endpoints" } }