Skip to content
Tài liệu tham khảo API
/
Tài nguyên chung
/
/Webhooks

Webhooks

API cho cấu hình webhook của nhóm.

Operations

Cấu hình webhook của nhóm

Request

Tạo mới hoặc thay thế cấu hình webhook của nhóm.

  • Điều kiện tiên quyết: callbackUrl phải là URL HTTPS dài từ 1 đến 1024 ký tự, có tên host, không chứa thông tin người dùng, không có fragment và cổng hợp lệ. Mọi địa chỉ mà nó phân giải ra đều phải định tuyến được trên internet; các dải localhost, riêng tư, link-local, CGNAT, metadata đám mây, dải dành riêng cho giao thức, dải dùng cho tài liệu và 6to4 sẽ bị từ chối. Cùng phép kiểm tra đó được thực hiện lại khi một lần gửi mở kết nối, nên một tên miền sau này phân giải vào dải riêng tư chỉ làm lần gửi đó thất bại chứ không chạm tới mạng của bạn.
  • Tác động: upsert cấu hình duy nhất thuộc nhóm trong ngữ cảnh phía máy chủ. teamId không bao giờ được đọc từ request, nên người gọi không thể cấu hình cho nhóm khác. Endpoint của Local API và Open API đọc và ghi cùng một bản ghi, và phản hồi phản ánh nội dung đã lưu.
  • Tắt: enabled: false giữ lại URL và dừng việc tạo sự kiện mới. Các sự kiện đã nằm trong hàng đợi sẽ bị hủy lần lượt nếu cấu hình vẫn đang tắt khi chúng được cấp phép lần kế tiếp, nên bật lại sớm sẽ cho chúng tiếp tục.
  • Thử lại: an toàn. Việc lưu là upsert theo nhóm, nên gửi lại cùng một request sẽ hội tụ về cùng một trạng thái.
  • Phiên bản client: cần client MoreLogin v2.66.0 trở lên, vì chính client máy tính mới expose route này ở local. Endpoint của Open API không phụ thuộc client.

Xem Webhooks để biết hợp đồng callback, tên sự kiện và lịch thử lại.

Các mã lỗi nghiệp vụ đã ghi nhận: 41001. Xem Error Codes để biết ý nghĩa từng mã. Mọi thao tác cũng có thể trả về các mã dùng chung.

Bodyapplication/json
callbackUrlstring, <= 1024 charactersrequired

URL HTTPS nhận sự kiện. Từ 1 đến 1024 ký tự.

enabledbooleanrequired

Việc gửi sự kiện có được bật cho nhóm hay không.

POST
/api/webhook/config
curl -i -X POST \
  http://127.0.0.1:40000/api/webhook/config \
  -H 'Content-Type: application/json' \
  -d '{
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  }'

Responses

Thành công. data là một đối tượng có các trường callbackUrl và enabled, phản ánh cấu hình đã lưu.

Headers
any
Bodyapplication/json
codeintegerrequired

Mã kết quả. 0 là thành công; các mã khác biểu thị ngoại lệ.

msgstring or nullrequired

Thông báo lỗi

dataobjectrequired
requestIdstringrequired

ID yêu cầu của thao tác

Response
{
  "code": 0,
  "msg": "",
  "data": {
    "callbackUrl": "https://example.com/morelogin/webhook",
    "enabled": true
  },
  "requestId": ""
}