このページの内容
Webhookのテスト
パブリックWebhookレシーバーを使用してWebhookをテストし、必要なデータを取得していることを確認します。
Webhookをテストすることで、設定プロセスを検証できるほか、Mistから受信したイベントメッセージを検査して解析できます。利用可能なWebhookレシーバーがない場合は、パブリックの無料サービスを使用できます。このようなサービスの多くは、Mistから受信するWebhook POST メッセージを受信して検査ジュニパーことができます。
これらのパブリック サイトは、一時的に使用できるランダムな URL を作成します。受信したデータは一時的なものであり、ブラウザを閉じるとすぐに削除されます。ブラウザーからこれらのサイトのいずれかを使用して、メッセージペイロードからパラメーターデータを識別し、ワークフローの作成に役立てることができます。
Webhookを設定した後、それをトリガーし、パブリックWebhookレシーバーで受信したメッセージを表示できます。
これらの無料テスト用Webhookレシーバーのうちの2つは次のとおりです。
これらのサイトはジュニパーが管理するものではなく、ご自身の責任でご利用ください。
Webhookテスター
Mist組織のWebhookを簡単にテストおよび監視できるWebhookテスターツールがあります。Webhookテスターは、 Mist Webhookテスターから入手できます。これは、Mist orgでWebhook設定を自動的に作成・削除して受信し、受信したWebhookメッセージをテーブルに表示するアプリケーションです。
-
このアプリケーションを使用できるのはローカルのMistアカウントのみです(SSOユーザーはサポートされていません)。
-
スーパーユーザーのロールを持つ管理者のみがサポートされます(組織レベルのWebhookはスーパーユーザーが設定できます)。
以下は、アプリケーションがどのように機能するかを説明する図です。
Webhookテスターを使用するには、簡単に以下を実行します。
Mist Webhookテスターに移動します。
設定ポップアップウィンドウで、次を選択します。
メモリ内の最大イベント—これは、アプリケーションのメモリに保存されるイベントの最大数です。
トピック—これらは受信するWebhookトピックです。Webhookトピックの限られたサブセットのみがサポートされ、その他のメッセージはすべて破棄されます。
組織—1つまたは複数のMist組織アプリケーションは、選択した組織に新しい Webhook 設定を自動的に作成し、有効なトピックをアプリケーションに送信します。
「保存」をクリックします。
イベントが発生すると、これらのWebhookがテーブルに送信され、監視および確認できます。日付、トピック、イベントタイプ、組織、サイト、デバイス名、デバイスMAC、イベントの詳細などの情報がテーブルに表示されます。
詳細については、「 https://github.com/Mist-Automation-Programmability/mist_webhook_monitor?tab=readme-ov-file」を参照してください。
エンドツーエンドの接続性をテストする
Webhookを使用すると、Mist Cloudインスタンスから定義済みのWebhookレシーバーまでのエンドツーエンド接続をテストして、Webhookを受信して処理できることを確認できます。これは、Webhook が動作しているかどうかをテストするための Webhook です。これは、ネットワーク接続をテストするための ping と同じ機能を実行しますが、Webhook の機能をテストします。これにより、2つのエンドポイント間の通信をブロックしているデバイス(ファイアウォールまたはルーター)がないことが検証されます。
これは、次の例に示すように、(REST クライアントから)組織、構成済みの Webhook (id) に POST を発行することで、API から行うことができます。
POST
/api/v1/orgs/203d3d02-dbc0-4c1b-xxxx-xxxxxxxxxxxx/webhooks/032b9cb1-80af-4edc-xxxx-xxxxxxxxxxxx/ping
成功した結果は次のようになります。
{
"topic": "ping",
"events": [
{
"id": "032b9cb1-80af-4edc-xxxx-xxxxxxxxxxxx",
"name": "my webhook",
"org_id": "203d3d02-dbc0-4c1b-xxxx-xxxxxxxxxxxx",
"timestamp": 1725375149.0829651
}
]
}
これは、ジュニパーのMistポータルから行うこともできます。
組織>管理>設定に移動します。
Webhooksセクションを見つけて、Webhookを追加ボタンをクリックします。
適切な Webhookタイプを選択し、テストWebhookに名前を付けてから、無料のWebhookテスト受信者のWebサイト(上記のリンクを参照)から取得したテストURLを URL フィールドに貼り付けます。
- メッセージを受信するWebhookトピックを選択し、その他の必要な設定を設定します。
- 最後に、[ 追加] を選択します。
組織設定ページの Webhook セクションにリストされているテストWebhookを見つけ、 表示 をクリックして配信イベントを確認します。これらのイベントをチェックしてWebhookの配信ステータスを確認し、Webhookを受信して処理できることを確認できます。
追加テスト情報
WebサーバーがMist Webhookを受信して処理できるテスト方法など、Webhookテストに関するその他の情報を確認するには、「 配信の検証」の情報を参照してください。
サイトWebhookにpingイベントを送信する方法については、「 Ping Site Webhook」を参照してください。
組織のWebhookにpingイベントを送信する方法については、「 Ping Org Webhook」を参照してください。