← API 參考
Webhook 端點POST

建立 Webhook 端點

建立 Webhook 接收端。url 必須是絕對 HTTP(S) URL，正式環境建議 HTTPS；status 僅可為 active / inactive。subscribed_events 接受公開事件或 ["*"]，max_attempts 範圍 0..5。

https://api.unifyport.ai/v1/webhook-endpoints

請求標頭

X-Api-Key
string必填

工作區 API Key，工作區會由此標頭解析得到。

Content-Type
string必填

傳送 JSON 請求內容時請使用 application/json。

路徑參數

此介面沒有路徑參數。

請求內容

url
string必填

接收 Webhook 的絕對 HTTP(S) URL；正式環境建議 HTTPS。

format: uri

status
string必填

端點狀態：active 或 inactive。

enum: active, inactive

subscribed_events[]
string[]

推送到此端點的公開標準事件；["*"] 代表全部公開事件，不包含 provider.raw_event。

signing_secret
string

可選的 Webhook 簽章密鑰，範例中請使用佔位符。

retry_policy
object

可選的重試政策。max_attempts 是首次投遞後的重試次數，預設 3，範圍 0 到 5；0 代表只做首次投遞。

max_attempts
integer

首次投遞後的重試次數，範圍為 0 到 5。

回應內容

id
string

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

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。

回應

201
201 Created

請求成功，回應內容範例如上。

400
請求錯誤

請求內容、路徑或參數無效。

401
未授權

X-Api-Key 請求標頭缺少或無效。

請求

curl -X POST https://api.unifyport.ai/v1/webhook-endpoints \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/webhook",
  "status": "active",
  "subscribed_events": ["*"],
  "signing_secret": "<WEBHOOK_SIGNING_SECRET>"
}'

回應

{
  "data": {
    "id": "we_example",
    "url": "https://example.com/webhook",
    "status": "active",
    "subscribed_events": ["*"],
    "signing_enabled": true,
    "retry_policy": {
      "max_attempts": 3
    }
  }
}