Mỗi sự kiện có một type cố định. Khi thêm webhook, bạn chọn những loại muốn nhận; chỉ sự kiện thuộc các tổ chức mà webhook được phép truy cập mới được gửi.
Danh sách sự kiện
Phần tiêu đề “Danh sách sự kiện”type | Khi nào xảy ra |
|---|---|
invoice.created | Một hoá đơn mới và duy nhất được thêm vào hệ thống, từ bất kỳ nguồn nào. |
invoice.updated | Dữ liệu hoặc trạng thái của hoá đơn đã có thay đổi, ví dụ bị thay thế hoặc điều chỉnh. |
invoice.checked | Kết quả kiểm tra của hoá đơn được tính xong hoặc tính lại. |
email.received | Hộp thư nhận một email mới. |
tax_connection.status_changed | Trạng thái kết nối Cơ quan Thuế của một MST thay đổi, ví dụ chuyển sang sai mật khẩu hoặc bị khoá. |
credits.low | Credit trong ví còn thấp hơn ngưỡng cảnh báo. |
customs.imported | Tờ khai hải quan được nhập xong. |
Khung gói tin
Phần tiêu đề “Khung gói tin”Mọi sự kiện dùng chung khung { id, type, created_at, org_id, data } mô tả ở Tổng quan webhook. Phần data khác nhau theo loại.
Nội dung data
Phần tiêu đề “Nội dung data”Cấu trúc data của từng sự kiện (các trường, kiểu dữ liệu, ví dụ đầy đủ) được sinh từ đặc tả OpenAPI và sẽ được bổ sung ở đây khi đặc tả được công bố. Trong lúc chờ, hãy coi data là dữ liệu có thể thêm trường mới và chỉ đọc những trường bạn cần.
Gợi ý chọn sự kiện
Phần tiêu đề “Gợi ý chọn sự kiện”| Mục tiêu | Sự kiện nên đăng ký |
|---|---|
| Đẩy hoá đơn mới sang ERP | invoice.created, invoice.updated |
| Cập nhật kết quả kiểm tra trong hệ thống của bạn | invoice.checked |
| Cảnh báo khi cần nạp credit | credits.low |
| Cảnh báo khi mất kết nối cổng thuế | tax_connection.status_changed |