Webhooks

Khi các sự kiện xảy ra tại phòng khám của bạn, một thông báo có chữ ký sẽ được gửi đến địa chỉ đã đăng ký; bạn giữ hệ thống của mình cập nhật theo thời gian thực.

Các endpoint thuộc tài nguyên này. Mỗi endpoint bị giới hạn trong dữ liệu phòng khám mà khóa API gắn với; các endpoint ghi hỗ trợ tiêu đề Idempotency-Key.

Ví dụ Sử dụng

Đăng ký webhook

curl -X POST https://api.udentiva.com/v1/webhooks \
  -H "Authorization: Bearer udk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://siz.example/hook","events":["payment.created"]}'

HTTP/1.1 201 Created
{
  "id": "wh-1",
  "url": "https://siz.example/hook",
  "events": ["payment.created"],
  "secret": "whsec_xxx"
}

Bảo mật ở tài nguyên này

Bảo mật không phải là một tính năng, mà là chính kiến trúc. Những đảm bảo có hiệu lực tại tài nguyên này:

Định dạng Lỗi

Lỗi trả về trong một phong bì nhất quán; mã hướng đến máy, thông điệp hướng đến người dùng. Lỗi nội bộ/stack không bao giờ bị rò rỉ.

{
  "error": {
    "code": "validation_failed",
    "message": "Trường không hợp lệ: email"
  }
}

Tài nguyên khác