← Tham chiếu API
Webhook EndpointPOST

Tạo điểm cuối Webhook

Tạo Webhook tại URL HTTP(S) tuyệt đối; production nên dùng HTTPS. status là active hoặc inactive. subscribed_events nhận public event hoặc ["*"]; max_attempts 0..5.

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

Tiêu đề

X-Api-Key
stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Content-Type
stringbắt buộc

Dùng application/json khi gửi nội dung yêu cầu JSON.

Tham số đường dẫn

Điểm cuối này không có tham số đường dẫn.

Nội dung yêu cầu

url
stringbắt buộc

URL HTTP(S) tuyệt đối nhận Webhook; production nên dùng HTTPS.

format: uri

status
stringbắt buộc

Trạng thái endpoint: active hoặc inactive.

enum: active, inactive

subscribed_events[]
string[]

Public standard event được gửi tới điểm cuối. ["*"] đăng ký mọi public event nhưng không gồm provider.raw_event.

signing_secret
string

Secret ký Webhook tuỳ chọn. Dùng placeholder trong ví dụ.

retry_policy
object

max_attempts là số lần retry sau lần gửi đầu, mặc định 3, phạm vi 0–5; 0 chỉ gửi lần đầu.

max_attempts
integer

Số lần retry sau lần gửi đầu, từ 0 đến 5.

Nội dung phản hồi

id
string

Định danh điểm cuối webhook (we_...).

url
string

URL HTTP(S) tuyệt đối nhận webhook; production nên dùng HTTPS.

format: uri

status
string

Trạng thái điểm cuối: active hoặc inactive.

enum: active, inactive

subscribed_events[]
string[]

Public standard event của điểm cuối; ["*"] nghĩa là mọi public event, không gồm provider.raw_event.

signing_enabled
boolean

true khi đã đặt secret ký và các lượt gửi được ký.

retry_policy
object

max_attempts đếm retry sau lần gửi đầu, mặc định 3, phạm vi 0–5.

max_attempts
integer

Số lần retry đã cấu hình sau lần gửi đầu, từ 0 đến 5.

Phản hồi

201
201 Created

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400
Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401
Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

Yêu cầu

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>"
}'

Phản hồi

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