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