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