將 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