Webhook EndpointPOST

Tạo điểm cuối Webhook

Tạo một bộ nhận Webhook. subscribed_events nhận các tên sự kiện chuẩn của nền tảng (như message.received, account.status.updated); dùng ["*"] để đăng ký mọi sự kiện. Tên sự kiện không hợp lệ sẽ bị từ chối. signing_secret là tuỳ chọn — nếu để trống hoặc bỏ qua thì tắt ký cho điểm cuối. retry_policy.max_attempts phải là số nguyên không âm; 0 tắt retry; giá trị không phải số nguyên sẽ bị từ chối.

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

Endpoint HTTPS nhận sự kiện Webhook.

status

string

Trạng thái điểm cuối, thường là active hoặc inactive.

subscribed_events

string[]

Các loại sự kiện được gửi tới điểm cuối. Dùng ["*"] để đăng ký mọi sự kiện; xem danh mục sự kiện chuẩn để biết tên đầy đủ.

signing_secret

string

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

retry_policy

object

Cấu hình retry như max_attempts.

Nội dung phản hồi

id

string

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

url

string

URL HTTPS nhận các lượt gửi webhook.

status

string

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

subscribed_events

string[]

Các loại sự kiện được gửi tới điểm cuối; ["*"] nghĩa là mọi sự kiện.

signing_enabled

boolean

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

retry_policy

object

Cấu hình retry, ví dụ max_attempts.

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ệ.

409

Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

500

Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

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