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