API から Webhook を構成する
API を使用した Webhook の構成について理解を深めましょう。
Webhook は、Juniper Mist ポータルを使用するのではなく、API から構成できます。
Webhook を構成するときは、常に構成階層に注意してください。
-
Organization レベルの Webhook で、Organization ID を指定します。
/api/v1/orgs/{org-id}/webhooks手記:{org-id} を見つけるには、Juniper Mist ポータルの左側のメニューから [組織 > の設定 ] を選択します。組織 ID は、[組織の設定] ページの上部に表示されます。
-
サイトレベルの Webhook で、サイト ID を指定します。
/api/v1/sites/{site-id}/webhooks手記:{site-id} を見つけるには、Juniper Mist ポータルの左側のメニューから [組織 > サイト構成 ] を選択します。次に、サイトを選択します。サイト ID は、サイト構成ページの上部に表示されます。
例: サイト構成
次の関数は、特定のサイトに設定されたすべての Webhook を表示します。
/api/v1/sites/4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx/webhooks
次の出力は、前の API 呼び出しの結果です。
HTTP 200 OK
Allow: POST, OPTIONS, GET
Content-Type: application/vnd.api+json
Vary: Accept
[
{
"name": "Lobby-Zone-Events",
"url": "https://webhook.site/02747ddc-2b1f-4134-a1eb-xxxxxxxxxxxx",
"secret": "",
"enabled": true,
"topics": "zone",
"verify_cert": true,
"id": "20538707-b873-4a60-xxxx-xxxxxxxxxxxx",
"for_site": true,
"site_id": "4ac1dcf4-9d8b-7211-xxxx-xxxxxxxxxxxx",
"org_id": "3f12cb79-fb5e-4d4b-xxxx-xxxxxxxxxxxx",
"created_time": 1686252096,
"modified_time": 1686252096
}
]