SanityをShopify Flowに接続する方法
Sanityでは、クエリに一致するコンテンツが作成、更新、または削除されるたびに、GROQを活用したWebhookを送信します。Workflow Webhooksはこの呼び出しをShopify Flowのトリガーに変換するため、ストア側でそれに応じて処理を行うことができます。具体的には、お客様へのタグ付け、注文メモの追加、社内メールの送信、メタフィールドの更新など、Shopify Flowで可能なあらゆる操作を実行できます。
このガイドでは、Sanityが送信し、Workflow Webhooksが受信・検証を行い、Shopify Flowが処理を行うという一連の流れをすべて設定します。すべてのリクエストにおいてSanityのHMAC署名が検証されるため、Sanity以外ではワークフローを開始することができません。
どのようなものを作れるか
- 対応するCMSエントリが変更された際に、Shopifyのメタフィールドを更新し、ストアフロントが常に同期された状態を維持できるようにします。
- ランディングページが公開されたら、マーチャンダイジングチームにメールをお送りください。
- コンテンツの公開後に、キャッシュウォームアップのワークフローを開始してください。
送信される代表的なイベントとしては、ドキュメントの公開、ドキュメントの更新、ドキュメントの削除などがあります。
始める前に
- Workflow Webhooks Shopifyストアにインストールされています。
- Shopify Flow インストール済みです。これは、ShopifyのApp Storeから無料で入手できます。
- Sanity上のアカウントで、Webhookを作成する権限があるもの。
ステップ 1 - Workflow Webhooks で Webhook を作成します
- Workflow Webhooks を開き**、[Webhook] → [Create Webhook]** の順に選択し、Shopify Flow で識別しやすい名前（例：
Sanity events）を付けてください。 - **「認証」**で、「**HMAC」**を選択してください。
- 「署名プロバイダー」で「Sanity」を選択してください。アプリがヘッダー、アルゴリズム、署名付きペイロード、リプレイウィンドウを自動的に入力してくれますので、他に設定する必要はありません。
- 「秘密鍵」の欄はひとまず空のままにして、「保存」をクリックしてください。ページに表示されているWebhook URLをコピーしてください。
その他の認証モードについては、認証 を、Shopify Flow に送信するフィールドの選択については、ペイロードのマッピングとShopify Flow変数 をご参照ください。
ステップ 2 - Sanity にエンドポイントを追加する
Sanityで、[API] → [Webhook] を開き、コピーしたURLを使用してGROQ対応のWebhookを作成し、シークレットを設定してください。
Sanityの署名用秘密鍵の確認方法
GROQが提供するWebhookに設定された「The Secret」です。
SanityのWebhook署名に関する公式ドキュメント（）には、お客様のアカウントに関する正確な説明文とスクリーンショットが掲載されています。
そのシークレットを、Workflow Webhooks の Webhook の**「Secret」**フィールドに貼り付けて、保存してください。それ以降、Sanity からのすべての配信は、Shopify Flow に届く前に検証されるようになります。
これが何をチェックするのか
| 何 | 値 |
|---|---|
| 署名ヘッダー | sanity-webhook-signature |
| 署名の位置 | そのヘッダーのv1値には、コンマで区切られたkey=valueのペアが含まれています |
| 何が署名されたのでしょうか | {timestamp}.{body} |
| 署名 | HMAC-SHA256、base64urlエンコード済み |
| タイムスタンプ | 署名ヘッダーのtの値（Unixミリ秒単位） |
| リプレイ防止機能 | なし - この送信者はタイムスタンプに署名を行わないため、すべての有効な署名は引き続き有効です |
| その秘密 | プレーンテキストとして使用します。送信者が表示した通りに、そのまま貼り付けてください。 |
署名付きペイロードにおいて、{body} はバイト単位で生のリクエスト本文であり、{timestamp} は上記のタイムスタンプです。
これらのいずれかの条件を満たさないリクエストは、401 のエラーで拒否され、沿革とトラブルシューティング に記録され、ワークフローは開始されません。
ステップ 3 - 「Shopify Flow」ワークフローを作成する
- Shopify Flow でワークフローを作成し、「Workflow Webhooks」トリガーを選択してください。
- 「**イベントの記録」**をクリックし、Sanityからテストイベントを送信してください（または、Workflow Webhooksで「テストを送信」を使用してください）。これにより、Shopify Flowがデータの構造を学習します。
- 所有しているすべてのWebhookは同じFlowトリガーを起動するため、このワークフローの対象をSanityのみに限定するために、Webhook IDを最初の条件として追加してください。IDはWebhookページに表示されています。
- アクションを追加してください ― お客様にタグを付けたり、メモを追加したり、社内メールを送信したり、メタフィールドを更新したりできます。
ステップ4 - エンドツーエンドでテストする
Sanityで実際のイベントをトリガーしてください。**「Workflow Webhooks」→「History」**に、ステータスが「**Success」**の呼び出しが表示されるはずです。署名が正しくなかった場合は、その理由が記載された失敗のエントリが表示されます。また、署名付きWebhookの検証 には、どのステップで失敗したかを正確に示す署名テスターの説明が記載されています。
署名が一致しません▾
順に、シークレット（最も一般的な原因：余分なスペース、または誤った環境のキー）、送信者が別のエンドポイントのシークレットを使用しているかどうか、そしてSanityとアプリの間でボディが書き換えられているかどうかです。署名は生のバイト列を対象としているため、JSONのフォーマットを変更するプロキシによって署名が破損してしまいます。 Webhookページの署名テスターには、署名された正確なテキストが表示されます。
どのリクエストでも401エラーが表示されます▾
Webhookの認証設定が**「HMAC」**に設定されており、プロバイダーとして「Sanity」が選択されていること、シークレットが入力されていること、そしてSanityがアプリに表示されているURLと完全に一致する形式で（末尾のコードを含めて）投稿を行っていることをご確認ください。
「履歴」には何も表示されません▾
リクエストは届きませんでした。SanityでURLを再度確認し、Sanity自身の配信ログで受信したレスポンスをご確認ください。「404」というエラーは、Webhookが間違っているか削除されていることを意味します。「429」というエラーは、プランの呼び出し制限を超えていることを意味します。詳細は プランと利用方法 をご覧ください。
ワークフローが誤ったイベントに対して実行されてしまいます▾
ストア内のすべてのWebhookは、同じFlowトリガーを起動します。ワークフローの最初のステップとして、WebhookIDに基づく条件を追加するか、Sanityから送信するイベントを絞り込んでください。
関連情報
- 署名付きWebhookの検証 - 当社が審査済みのすべてのプロバイダー、および審査対象外のプロバイダーについてどのように記載するか。
- ペイロードのマッピングとShopify Flow変数 - ペイロードから適切なフィールドを抽出し、Shopify Flowに取り込むこと。
- 重複配送防止 - Sanityが配信を再試行すると、どうなるのでしょうか。
- 沿革とトラブルシューティング - すべてのリクエストのログ（再生機能付き）。