Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Webhook の概要

Webhook と API との比較について理解を深めましょう。

Webhook を構成して、Juniper Mist組織全体または特定のJuniper Mistサイト内でイベントが発生したときにリアルタイムで通知を受け取ることができます。

Webhook は、ユーザー定義の HTTP コールバック、HTTP ポスト、または HTTP 通知として知られている場合があります。これらの通知には、独自のアプリケーションまたはサードパーティソフトウェアで使用できるイベントの詳細が含まれます。

Webhook の使用を開始するときは、API と比較すると役立つ場合があります。API は、プル モデルまたはポーリング モデルで動作します。API 呼び出しを作成すると、Juniper Mist要求されたデータで応答します。対照的に、Webhook はプッシュモデルで動作します。Webhook を構成すると、イベントが発生したときにデータを受信します。

組織の Webhook を使用すると、組織からのリアルタイムデータを指定された URL にプッシュできます。詳細については、「 組織の Webhook」を参照してください

サイト Webhook を使用すると、特定のサイトからのリアルタイム データを指定された URL にプッシュできます。詳細については、「 サイト Webhook」を参照してください

Illustration of the differences between APIs and Webhooks

表1:REST APIとWebhookの比較
REST API Webhook  
モデル プルまたはポーリング モデル プッシュモデル
極限 組織あたり 5000/時間 制限なし
オペレーションズ 統計情報の取得、構成の作成、構成の更新 プッシュアラートと主要な統計
カバレッジ 100% アラート、主要イベント、位置情報
推奨されるユースケース 自動化、設定 サードパーティの監視ツールまたはビジネスアプリケーションとの統合
手記:

アラートとアラームの概念は交換可能と見なされます。ただし、アラートを設定するときは、アラートまたはアラームの構文をメモし、表示されるものを使用する必要があります。

Webhook の API 呼び出し構造

Webhook を構成して、Mist組織内または特定のサイト内で発生したイベントのリアルタイム データと通知を取得できます。Webhook を設定したら、特定の Webhook を指定して API 呼び出しを発行してデータを取得できます。次の図は、このような API 呼び出しの例です。この呼び出しでは、API エンドポイント (プレフィックス)、組織 ID、リソース (webhooks)、Webhook ID (a7c61a9c-a25b-4c27-xxxx-xxxxxxxxxxxx) を指定します。

Example webhook with labels for API prefix, organization ID, resource, and webhook ID