ドキュメント高度な機能
Webhook
プロジェクトのWebhookページを理解し、埋め込みポータルの準備ができていない場合に復旧します。
Webhookを使用すると、別のサービスがRunnerプロジェクトから選択されたイベントを受け取ることができます。これは高度なセキュリティに敏感な機能です。どのサービスがイベントを受け取るべきか、そのサービスがそれらを検証する方法を知っている場合にのみ使用してください。
エントリパス
Runnerがワークスペースで利用可能にするエントリを通じてのみ、プロジェクトのWebhookページを開きます。エントリがない場合、URLを推測しないでください。機能の利用可能性を参照するか、機能が有効になっているかどうかについてサポートに問い合わせてください。
開始する前に
- WebhookはRunnerが承認されたエントリを公開する場合にのみ使用してください。
- 意図した受信サービスと、それがイベントを検証する方法を知ってください。
- エンドポイントアドレス、署名シークレット、および配信されたデータを機密として扱ってください。
Runnerが表示するもの
Runnerは埋め込み管理ポータルを表示する前にWebhookサービスを準備します。
| ページ状態またはコントロール | 意味または実行内容 |
|---|---|
| 読み込み中… | Runnerはwebhookサービスの準備ができているかどうかを確認しています。 |
| Webhookプラットフォームは初期化中です | セットアップはまだ進行中です。ページを開いたままにして待つか、後で戻ってください。 |
| 初期化が予想より長くかかっています | セットアップは通常の待機後に完了していません。再試行はRunnerにサービスを再度プロビジョニングするよう要求します。 |
| 再試行中… | 再試行が進行中です。リクエストが完了するまで、ボタンは利用不可のままです。 |
| エラーメッセージ | Runnerはサービスを準備できませんでした。表示されているメッセージをサポート用に保持してください。 |
| 埋め込みwebhookポータル | サービスの準備ができています。このプロバイダー管理ポータル内の正確なラベルとコントロールは変更される可能性があるため、このガイドの固定ボタン名に依存するのではなく、そこに表示されている指示に従ってください。 |
| Shopifyを再接続 | 古いShopify接続が新しいwebhook権限を必要とする場合、Shopify統合ページを開きます。Shopifyイベントの到着を期待する前に再接続してください。 |
長い初期化から復旧
- 初期化メッセージが完了するまで待ちます。
- 初期化が予想より長くかかっていますが表示される場合は、再試行を1回選択します。
- 埋め込みポータルが初期化画面を置き換えるまで待ちます。
- エラーが再度表示される場合は、プロジェクト名と正確なメッセージを保存してから、繰り返し再試行する代わりにサポートに連絡してください。
要求されたときにShopifyを再接続
- Shopifyストアを再接続通知を読みます。
- Shopifyを再接続を選択します。
- Shopify統合ページで接続フローを完了します。
- Webhookに戻り、イベント配信に依存する前に再接続通知が消えたことを確認します。
再接続はストアの統合認可を変更します。そのストア接続を管理することが許可されている人だけが続行する必要があります。
セキュリティに関する注記
- エンドポイントアドレス、署名シークレット、およびイベントコンテンツを機密として扱ってください。
- 宛先を追加または変更するのは、その所有者が正しい安全なアドレスを提供した場合のみです。
- 埋め込みポータル内に表示されるすべての確認を確認します。そのアクションは将来の配信に影響を与える可能性があります。
- 署名値が公開された場合は、より多くのイベントを送信する前に、Runnerのwebhookサービスと受信システムの両方で置き換えてください。
トラブルシューティング
| 問題 | 次のステップ |
|---|---|
| Webhookエントリなし | この機能はこのワークスペースで公開されていません。機能の利用可能性を確認してください。 |
| 初期化が完了しない | 再試行を1回使用してから、繰り返される場合は正確な状態を報告してください。 |
| エラーメッセージが表示される | 完全なメッセージとプロジェクト名をサポート用に保持してください。 |
| Shopify再接続通知が残る | 統合ページから再接続を完了してから、Webhookを1回リロードしてください。 |
| 埋め込みポータルが空白または異なる動作をする | 1回リロードしてください。それが続く場合、表示されているものをキャプチャしてください。埋め込みプロバイダーインターフェースはアカウントまたはリリースによって異なる場合があります。 |