Webhook Endpoint

Vô hiệu hoá điểm cuối Webhook

Đặt trạng thái điểm cuối Webhook thành inactive mà không xoá điểm cuối.

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

Kênh được hỗ trợ

all

Trước khi gọi

Dùng X-Api-Key của workspace sở hữu tài nguyên trên máy chủ. Thay mọi giá trị mẫu trước khi chạy.

Nguồn tham số

account_id: Lấy data.id từ phản hồi tạo hoặc truy vấn tài khoản. ID thuộc workspace của X-Api-Key. Lấy tài khoản

Tham số yêu cầu

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.

Tham số đường dẫn

endpoint_id

stringbắt buộc

Định danh dùng cho route webhook endpoints.

Tham số truy vấn

account_id

string

ID tài khoản công khai tùy chọn, ví dụ acc_example. Không được rỗng, chỉ chứa khoảng trắng hoặc lặp lại. Tên tham số phải đúng là account_id; biến thể chữ hoa/chữ thường trả về 400 invalid_request, không được coi là bỏ qua. Khi liệt kê, bỏ qua thì chỉ trả về endpoint của không gian làm việc; chỉ định thì chỉ trả về cấu hình độc lập của tài khoản (data=[] nếu không có, không kèm cấu hình kế thừa từ không gian làm việc). Lấy chi tiết, vô hiệu hóa và xóa chỉ kiểm tra tài khoản sở hữu hiện có; không khớp trả về 400 invalid_request. Tài khoản được chỉ định không tồn tại hoặc không thuộc không gian làm việc hiện tại trả về 404 account_not_found (20020).

minLength: 1 · pattern: \S

Nội dung yêu cầu

Điểm cuối này không cần nội dung JSON.

Hiểu kết quả

Xác nhận status=inactive trong phản hồi. Không chờ giao sự kiện mới qua điểm nhận này; việc vô hiệu hóa không bảo đảm hủy yêu cầu đang được gửi.

Phản hồi 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "we_example",
    "url": "https://example.com/webhook-updated",
    "status": "inactive",
    "subscribed_events": [
      "message.delivered",
      "message.read"
    ],
    "signing_enabled": false,
    "retry_policy": {
      "max_attempts": 1
    }
  }
}

Nội dung phản hồi

id

string

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

account_id

string

ID tài khoản công khai của endpoint độc lập của tài khoản; được bỏ qua với endpoint của không gian làm việc, không trả về null.

minLength: 1

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

200

200 OK

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

404

Not Found

Không tìm thấy tài nguyên được yêu cầu. Kiểm tra error.code cùng với thao tác hiện tại.

Khi yêu cầu thất bại

Kiểm tra HTTP và error.code/numeric_code, giữ request_id. Sửa tham số, tiếp tục xác thực hoặc kiểm tra runtime tùy nguyên nhân. Xác nhận kết quả cũ trước khi thử lại thao tác gửi hoặc ghi. Tham chiếu mã lỗi

invalid_request · 10000 · 400: Kiểm tra trường bắt buộc, định dạng và điều kiện kênh rồi sửa yêu cầu.
missing_api_key · 11000 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.
invalid_api_key · 11001 · 401: Kiểm tra X-Api-Key và workspace còn hoạt động.