Webhook 端點

攞 Webhook 端點

回傳單一 Webhook 端點嘅設定。

GEThttps://api.unifyport.ai/v1/webhook-endpoints/{endpoint_id}

支援渠道

all

呼叫前準備

在伺服器端使用資源所屬工作區的 X-Api-Key，執行範例前替換所有預留位置。

參數從哪裡取得

account_id: 從建立或查詢帳號的回應取得 data.id。帳號屬於 X-Api-Key 對應的工作區。攞帳號

請求參數

請求標頭

X-Api-Key

string必填

工作區 API Key，工作區會由呢個標頭解析得出嚟。

路徑參數

endpoint_id

string必填

用嚟識別嗰條 webhook endpoints 路由嘅 ID。

查詢參數

account_id

string

可選嘅公開帳號 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
    }
  }
}

回應內容

id

string

Webhook 端點識別碼（we_...）。

account_id

string

帳號獨立端點嘅公開帳號 ID；工作空間端點會省略呢個欄位，唔會回傳 null。

minLength: 1

url

string

接收 webhook 派送嘅絕對 HTTP(S) URL；正式環境建議 HTTPS。

format: uri

status

string

端點狀態：active 或者 inactive。

enum: active, inactive

subscribed_events[]

string[]

派去呢個端點嘅公開標準事件類型；["*"] 即係全部公開事件，唔包括 provider.raw_event。

signing_enabled

boolean

設咗簽名密鑰、派送會簽名嗰陣會係 true。

retry_policy

object

API 回傳嘅重試設定。max_attempts 統計首次投遞之後嘅重試次數，預設 3，範圍 0 到 5。

max_attempts

integer

已設定嘅首次投遞後重試次數，範圍係 0 到 5。

回應

200

200 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 與工作區是否有效。