Gửi webhook đến hệ thống của bạn

Sự kiện

Kết nối webhook

1. Trong Foliant, vào Cài đặt › Tích hợp.
2. Trên Webhooks, nhấp vào Kết nối.
3. Điền các cài đặt:

   Trường	Nội dung cần nhập
   Endpoint URL	Địa chỉ Foliant gửi sự kiện đến. Địa chỉ phải dùng HTTPS, chẳng hạn https://example.com/webhooks/foliant.
   Signing secret	Không bắt buộc. Khi có secret, mọi yêu cầu đều được ký để bạn có thể kiểm tra yêu cầu đến từ Foliant.
   Events	Các sự kiện cần gửi. Theo mặc định, cả hai đều được chọn.

4. Nhấp vào Kết nối.

Nội dung của mỗi yêu cầu

{
  "id": "a unique delivery id",
  "event": "document.generated",
  "created_at": "2026-10-11T09:30:00+00:00",
  "shop": "your-store.myshopify.com",
  "data": { }
}

Dữ liệu của document.generated

• template: uuid và name của mẫu.
• document_type: invoice, credit_note, quote, hoặc để trống với các tài liệu khác.
• order: id, name và type của đơn hàng (đơn hàng hoặc đơn hàng nháp).
• refund_id và fulfillment_id, khi tài liệu dành cho một khoản hoàn tiền hoặc một lần giao hàng.
• document_number và issued_at, với các tài liệu có đánh số.
• source: cách tài liệu được tạo, chẳng hạn download, admin_download, export hoặc email.
• export: ID của lượt xuất, khi tài liệu thuộc một lượt xuất.
• generated_at.

Dữ liệu của export.completed

• export: uuid, order_type, template_uuids, số orders, orders_skipped (bị xóa sau khi được chọn) và documents, requested_by (merchant hoặc customer) và completed_at của lượt xuất.
• download_url: liên kết để tải lượt xuất xuống, và download_url_expires_at, thời điểm liên kết đó hết hiệu lực.
• download_expires_at: thời điểm bản thân lượt xuất hết hạn.

Header

Kiểm tra chữ ký

Phản hồi và gửi lại

• Mọi phản hồi 2xx đều được tính là đã gửi thành công.
• Nếu endpoint của bạn trả về lỗi 5xx, 408 hoặc 429, hoặc không phản hồi trong vòng 10 giây, Foliant sẽ thử lại sau, mỗi lần chờ lâu hơn, tối đa 5 lần.
• Các phản hồi 4xx khác là kết quả cuối cùng: Foliant không thử lại.
• Mỗi sự kiện được gửi một lần cho mỗi tài liệu hoặc lượt xuất. Sau khi gửi thành công, việc thử lại không bao giờ gửi sự kiện hai lần.

Bài viết liên quan

• Kết nối và quản lý tích hợp
• Hoạt động của tích hợp
• Tự động hóa với Shopify Flow
• Xuất PDF