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 請求標頭缺少或無效。
404找不到資源
找不到請求的資源；請結合 error.code 和目前操作核對。
500伺服器錯誤
服務遇到了未預期的錯誤。
失敗後如何處理
檢查 HTTP 狀態和 error.code/numeric_code，保留 request_id。依原因修正參數、繼續授權或檢查狀態。重試傳送及寫入前確認上次結果，避免重複操作。 錯誤碼參考
- invalid_request · 10000 · 400
- 檢查必填欄位、格式與渠道條件，修正請求後再呼叫。
- missing_api_key · 11000 · 401
- 檢查 X-Api-Key 與工作區是否有效。
- invalid_api_key · 11001 · 401
- 檢查 X-Api-Key 與工作區是否有效。