Webhookのデバッグに便利なツール「Runscope」の紹介

以前のブログで「Beeceptor」と「Webhook.site」というWebhookのデバッグツールを紹介しました。

今回は「Runscope」を紹介します。これまでのツールと異なり、Webhookのデバッグに特化したものではないのですが、Webhookの動作確認ができます。

Runscopeとは?

RunscopeはWeb APIをテストするためのサービスで、複数のAPIを使った連携やエンドポイントの死活監視などができます。

Runscope

HTTPリクエストを受信する機能もあるので、今回はこの機能を利用してWebhookのデバッグを行います。Runscopeでは受信もテストの扱いとなるため、受信するたびにテストの実行が必要です。これまでに紹介してきたツールと使い勝手が異なるのでご注意ください。

設定手順

SendGridのEvent Webhookを例に設定手順を紹介します。

Runscopeではテストという括りの中でAPIの呼び出しを定義するため、最初にテストを作成する必要があります。ここでは「SendGridEventWebhookTest」という名前のテストを作成しました。

テストを作成

APIはステップという単位で登録します。作成したテストにはデフォルトでHTTPリクエストのステップが存在しますが、これは使わないので削除してください。削除したら、Webhookを受けることができるIncoming Requestステップを作成します。

HTTPリクエストのステップを削除

下画面のトグルボタンでFIXED URLにして、発行されたURLをコピーしてください。

発行されたURLをコピー

Save&Runボタンを押すと設定が保存され、HTTPリクエストを受け付ける状態になります。

HTTPリクエストを受け付ける状態

Runscope側の設定は以上です。

SendGridにログインして、さきほどコピーしたURLをSendGridのEvent Webhookに設定したらTest Your Integrationボタンを押してください。

Runscopeで生成されたURLを設定

Runscope側で以下のようにEvent Webhookのダミーイベントが受信できたら成功です。

Event Webhookのダミーイベントが受信できたら成功

今回はEvent Webhookを受信する方法のみを紹介しましたが、冒頭で書いたようにRunscopeはAPIをテストするためのサービスです。ぜひSendGridのAPIを使って色々と試してみてください。