/v1/webhooksDanh sách webhook
Lấy các webhook của ứng dụng xác định bởi app_id: URL, trạng thái bật và sự kiện đã đăng ký.
Giới thiệu
API trả các webhook đã thêm cho ứng dụng. Header app_id là UUID dùng để tìm ứng dụng. Header api_key phải là key đang hiệu lực của đúng ứng dụng đó. Key có thể được tạo lại, nên không dùng key để định danh ứng dụng. Key hddt_test_ chỉ gọi Sandbox, key Live chỉ gọi Live. Sandbox và Live là hai danh sách riêng.
Danh sách không trả secret dùng để ký thông báo. Secret chỉ có trong phản hồi của API Thêm webhook. Endpoint không dùng token hoá đơn và không trừ hạn mức phát hành.
Endpoint
Gửi GET. Host phải cùng môi trường với API key. Sandbox: https://sandbox.api.hddt.dev. Live: https://api.hddt.dev.
Chưa có webhook vẫn trả 200 và data là mảng rỗng.
Header
Gửi App ID để tìm ứng dụng, và API key của đúng ứng dụng đó.
app_idstringBắt buộcĐịnh danh ứng dụng (UUID). Sao chép App ID trên trang chi tiết ứng dụng (tab Kết nối & bảo mật).
api_keystringBắt buộcAPI key đang hiệu lực của ứng dụng có app_id ở trên.
Ví dụ
Lấy webhook sandbox của ứng dụng có App ID đã gửi.
curl https://sandbox.api.hddt.dev/v1/webhooks \
-H "app_id: $HDDT_APP_ID" \
-H "api_key: $HDDT_API_KEY"Phản hồi
Khi key hợp lệ, API trả 200. data là mảng webhook của môi trường đó.
objectstringBắt buộcLuôn là list.
dataarrayBắt buộcDanh sách webhook. Mảng rỗng khi chưa thêm webhook nào. Xem mục Webhook.
{
"object": "list",
"data": [
{
"id": "wh_8f2a1c9d",
"object": "webhook",
"url": "https://api.cua-ban.vn/webhooks/hddt",
"enabled": true,
"events": ["invoice_issued", "tax_authority_response"]
}
]
}Webhook
Mỗi phần tử của data là một webhook. Không có trường secret.
idstringBắt buộcĐịnh danh webhook, ví dụ wh_8f2a1c9d.
objectstringBắt buộcLuôn là webhook.
urlstringBắt buộcURL HTTPS nhận thông báo.
enabledbooleanBắt buộctrue khi webhook đang nhận thông báo, false khi đang tắt.
eventsarray of stringBắt buộcCác mã trong bảng Sự kiện đang đăng ký.
Sự kiện đang đăng ký
Mỗi phần tử của events là một mã dưới đây. all nhận mọi sự kiện còn lại.
| Mã | Trạng thái |
|---|---|
| all | Tất cả |
| template_created | Tạo mẫu hoá đơn |
| template_quantity_approved | Duyệt số lượng mẫu hoá đơn |
| template_deleted | Xoá mẫu hoá đơn |
| invoice_draft_created | Tạo nháp hoá đơn |
| invoice_issued | Phát hành hoá đơn |
| invoice_signed | Ký hoá đơn |
| tax_authority_response | CQT phản hồi |
| invoice_draft_deleted | Xoá hoá đơn nháp |
Mã lỗi
Lỗi xác thực trả mã HTTP kèm error.code và error.message.
401 unauthorized—Tuỳ chọnThiếu header app_id hoặc api_key; API key sai, đã thu hồi, hoặc không thuộc app_id.
403 forbidden—Tuỳ chọnGửi key của môi trường khác (key hddt_live_ tới host Sandbox, key hddt_test_ tới host Live).
404 not_found—Tuỳ chọnKhông có ứng dụng nào khớp app_id.
422 validation_error—Tuỳ chọnapp_id không phải UUID.