Webhooks
Docs/Tích hợp API & webhook

Nhận thông báo bằng webhook

Tạo endpoint nhận thông báo khi trạng thái tạo PDF thay đổi.

1 phút đọc6 phần
Trong bài này

Thông báo trạng thái

Thay vì liên tục hỏi công việc đã xong chưa, phần mềm của bạn có thể nhận thông báo khi trạng thái render thay đổi. Bạn vẫn nên lưu render ID và có cách kiểm tra status khi cần đối chiếu.

1. Chuẩn bị endpoint

Phần mềm nhận cần có endpoint HTTPS công khai mà hệ thống có thể truy cập. localhost và địa chỉ mạng riêng không phải endpoint công khai. Backend nhận phải kiểm tra chữ ký, không chỉ tin vì body trông giống Tembuilder.

2. Tạo endpoint trong ứng dụng

Mở Webhooks trong project, nhập tên và URL theo màn hình. Sau khi tạo, lưu signing secret vào nơi quản lý secret của backend. Secret chỉ được hiển thị lúc tạo; không đưa nó vào frontend hoặc ảnh chụp.

3. Gửi test

Dùng chức năng test, mở delivery và xem HTTP status, lần thử và lỗi. Request test có loại webhook.test; đừng nhầm đây là một PDF đã render thành công.

4. Dùng sự kiện render

Luồng render dùng sự kiện renders.status với các trạng thái nghiệp vụ. Endpoint nên phản hồi nhanh sau khi nhận và lưu công việc xử lý tiếp một cách an toàn. Việc phản hồi thành công không nên diễn ra trước khi hệ thống của bạn đã bảo đảm không làm mất sự kiện.

Bật/tắt và xử lý lỗi

Bật/tắt endpoint theo nhu cầu, xem lịch sử lần giao khi có lỗi. Tránh tạo endpoint mới liên tục để sửa một URL sai. Đọc bài xác minh chữ ký trước khi dùng cho dữ liệu thật.

Tìm tài liệu