独自のシステムにWebhookを送信する

イベント

Webhooksを接続する

1. Foliantで設定 › 連携に移動します。
2. Webhooksで接続をクリックします。
3. 設定を入力します。

   項目	入力する内容
   エンドポイントURL	Foliantがイベントを送信するアドレスです。https://example.com/webhooks/foliantのように、HTTPSを使用する必要があります。
   署名シークレット	任意です。シークレットを設定すると、すべてのリクエストに署名が付き、Foliantからの送信であることを確認できます。
   イベント	送信するイベントです。初期設定では両方が選択されています。

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は再試行しません。
• 各イベントは、書類またはエクスポートごとに1回配信されます。成功後に再試行で重複して送信されることはありません。

関連記事

• 連携を接続・管理する
• 連携のアクティビティ
• Shopify Flowで自動化する
• PDFをエクスポートする