credits.low

Sắp hết tín dụng

Số dư tín dụng của kỳ đã vượt một ngưỡng sử dụng (data.threshold, phần trăm lượng tín dụng được cấp đã dùng). Được gửi một lần cho mỗi ngưỡng và kỳ.

Loại đối tượng: org
Gửi tới: Webhook có vai trò admin

Payload

Đối tượng: EventCreditsLow

idstringbắt buộc
ID sự kiện (evt_…), cũng được gửi trong header webhook-id. Dùng nó để loại bỏ các lần gửi trùng lặp.
typestringbắt buộc
Giá trị cho phép: credits.low
created_atstring (date-time)bắt buộc
Thời điểm xảy ra thay đổi (UTC).
org_idintegerbắt buộc
api_versionstringbắt buộc
Phiên bản hợp đồng của lược đồ data.
sequenceinteger
Số thứ tự lần gửi trong phạm vi webhook (không có với sự kiện thử).
objectWebhookEventObjectbắt buộc
payloadstringbắt buộc
thin nghĩa là không có data: hãy đọc đối tượng qua API.
Giá trị cho phép: fullthin
dataobject
Trường
- thresholdintegerbắt buộc
  Ngưỡng tính bằng phần trăm định mức đã dùng: 80 hoặc 100.
- period_startstring (date)bắt buộc
- balancenumber
- allowancenumber
testbooleanbắt buộc
Sự kiện thử được gửi bằng POST /v1/webhooks/{webhook_id}/test.

Ví dụ một lần gửi

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "credits.low",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "org",
    "id": "1"
  },
  "payload": "full",
  "data": {
    "threshold": 80,
    "period_start": "2026-10-01",
    "balance": 1000,
    "allowance": 5000
  },
  "test": false
}

Nhận sự kiện

Mỗi lần gửi là một yêu cầu POST với phần thân JSON này tới webhook của bạn. Xác minh header webhook-signature (Standard Webhooks) trước khi tin vào phần thân, trả lời bằng trạng thái 2xx trong vài giây và xử lý công việc sau đó. Các lần gửi tới một webhook giữ đúng thứ tự sự kiện; lần gửi thất bại được thử lại với khoảng chờ tăng dần.

Loại sự kiện mới và trường mới có thể xuất hiện bất cứ lúc nào: hãy bỏ qua các loại và trường bạn không biết.

Các sự kiện này cũng có trong nguồn cấp sự kiện trong 30 ngày →