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