向您自己的系统发送 Webhook

事件

连接 Webhooks

1. 在 Foliant 中，前往 设置 › 集成。
2. 在 Webhooks 上，点击 连接。
3. 填写设置：

   字段	填写内容
   Endpoint URL	Foliant 发送事件的地址。必须使用 HTTPS，例如 https://example.com/webhooks/foliant。
   Signing secret	可选。设置密钥后，每个请求都会被签名，方便您确认请求来自 Foliant。
   Events	要发送的事件。默认两个都已选中。

4. 点击 连接。

每个请求包含的内容

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

document.generated 数据

• template：模板的 uuid 和 name。
• document_type：invoice、credit_note、quote，其他文档则为空。
• order：订单的 id、name 和 type（订单或草稿订单）。
• refund_id 和 fulfillment_id：当文档用于退款或发货时提供。
• document_number 和 issued_at：用于带编号的文档。
• source：文档的生成方式，例如 download、admin_download、export 或 email。
• export：导出的 ID，当文档属于某次导出时提供。
• generated_at。

export.completed 数据

• export：导出的 uuid、order_type、template_uuids、orders 数量、orders_skipped（选中后被删除的订单）和 documents、requested_by（merchant 或 customer）以及 completed_at。
• download_url：导出的下载链接；download_url_expires_at：该链接失效的时间。
• download_expires_at：导出本身过期的时间。

请求头

验证签名

响应与重试

• 任何 2xx 响应都视为已送达。
• 如果您的端点返回 5xx 错误、408 或 429，或在 10 秒内未响应，Foliant 会稍后重试，每次等待的时间更长，最多尝试 5 次。
• 其他 4xx 响应为最终结果：Foliant 不会重试。
• 每个事件针对每个文档或导出只送达一次。成功后，重试绝不会重复发送。

相关文章

• 连接和管理集成
• 集成活动
• 使用 Shopify Flow 实现自动化
• 导出 PDF