API から Webhook を作成するCreate Webhook from the API
次の手順に従って、POST コマンドを使用して新しい Webhook を設定します。
POST を使用して Webhook を設定し、トピックを有効にします。
API 呼び出しでは、構成階層と、組織とサイトで使用できるさまざまなトピックに注意してください。
-
API機能では、組織IDまたはサイトIDを必ず指定してください。 「API から Webhook を構成する」を参照してください。
-
topics行では、組織またはサイト レベルに適したトピックのみを指定してください。「Webhook トピック」を参照してください。
サイトレベルのトピックを有効にするようにサイト Webhook を構成する POST の例を次に示します。
POST構造の例についてはサイト間vpnの作成Webhookを参照してください。該当する場合は、「組織 Webhook の作成」も参照してください。応答の例を以下に示します。
{
"name": "analytic",
"type": "http-post",
"url": "https://username:password@hooks.abc.com/uri/...",
"secret": "secret",
"headers":{
"x-custom-1": "your_custom_header_value1",
"x-custom-2": "your_custom_header_value2"
},
"verify_cert": false,
"enabled": true,
"topics": [ "location", "zone", "vbeacon", "rssizone", "asset-raw-rssi", "device-events", "alarms", "audits", "client-join", "client-sessions", "device-updowns", "occupancy-alerts", "mxedge-events", "nac-accounting", "sdkclient-scan-data",]
}
コードブロックを再利用する場合は、プレースホルダー値を実際の値(APIトークン、組織ID、サイトID、AP名など)に置き換えます。
| パラメーター |
形容 |
|---|---|
| 名前 |
構成された Webhook の名前。 |
| 種類 |
Webhook のタイプ (http-post、splunk など)。 |
| URL (英語) |
Webhook の受信先。 |
| 秘密 |
|
| ヘッダー |
カスタムヘッダーは、 |
| verify_cert |
証明書の検証が有効になっているかどうか。True または False。 |
| 有効 |
Webhook が有効になっているかどうか。True または False。 |
| トピック |
メッセージまたはアラートを受信する選択したアイテム。詳細については、「 Webhook トピック」を参照してください。Mist API リファレンスの 「Webhook トピック」も参照してください。 |
「 Splunkタイプを使用したWebhookの保護」も参照してください。