Webhook Hierarchy
Understand the relationship between organizational- and site-level webhooks. Get familiar with the webhook topics that you can configure at each level.
Webhook Hierarchy Overview
Juniper Mist has two configuration hierarchies for webhooks: the organization level and site level. The configuration method is the same for both; however, not all webhooks are available at both levels.
-
All webhooks that are available at the organization level are also available for specific site-level webhooks.
-
The available site-level webhooks are not available at the organization level.
Be aware of the hierarchy when configuring webhooks.
As an example, if you have two sites and you configure the Alerts webhook at the organization level, you will receive all organization-level alerts for both sites.
Conversely, if you do not configure the Alerts webhook at the organization level and only configure the Alerts webhook on one of the two sites, you will receive alerts only for that single site.
Finally, if you configure the Alerts webhook at the organization level and a single site, the webhook receiver will receive duplicate messages (assuming they are sent to the same receiver URL).
You can configure multiple webhook receivers for a single webhook (and its topics) from the API. It is recommended to have a single webhook that includes all the available topics and then parse the information that you want from messages received by the webhook receiver.
Organization Webhooks
An Org Webhook is a configuration that enables organization data to be pushed to a specified URL. You can customize org webhooks using the Mist RESTful API, which enables you to obtain data from a specific organization.
You can configure these topics at the organization level:
Topic |
Description |
---|---|
Alerts |
Juniper Mist-defined alarm events configurable on a per-site basis in the alert framework. |
Audits |
A topic that tracks configuration changes made from the Juniper Mist dashboard. |
Client Join |
The webhook that Juniper Mist triggers whenever a client joins a wireless network. |
Client Information |
A topic that includes information about each client. |
Client Sessions |
The topic that includes information about the client sessions. |
Device Events |
A topic that is specific to events that occur on devices (currently AP, switch, and gateway) |
Device Up/Downs |
The topic that generates a message when a device starts up or goes down. |
Juniper Mist Edge Events |
The topic that generates messages for a Juniper Mist Edge port and link status changes and link aggregation control protocol (LACP) port and link changes. |
Site Webhooks
A Site Webhook is a configuration that enables site data and events to be pushed to a specified URL. You can customize site webhooks using the Mist API so that you can obtain data from a particular site.
You can configure these topics at the site level. The topics are classified under two categories—Standard and Advanced. You can select either one topic under the Advanced category or multiple topics under the Standard category for a webhook. You cannot select topics from both categories.
Location Webhooks
To use location webhooks, you must upload a floorplan with accurate AP placement through the Juniper Mist portal to correlate the client data. For more information, see the Floorplan Setup Overview in the Juniper Mist Location Services Guide.
Topic |
Description |
---|---|
Entry/Exit Events
|
Data pushed any time a client enters or exits one of these areas. |
Occupancy Alerts | Alerts on a configured zone occupancy threshold being exceeded. |
SDK Client Scan Data | Specific data about a client that isn’t available without installing an application (using the SDK) on the client itself. |
X/Y Coordinates
|
Data sent at regular intervals
of:
|
Asset Raw |
This topic will be deprecated. Use the BLE Asset RSSI topic. |
Network Service Webhooks
Topic |
Description |
---|---|
Latency |
A webhook that provides DHCP, DNS, and authentication latency information aggregated across all the client devices at the site level. |
You'll need a Marvis subscription to subscribe to this webhook.
Infrastructure Webhooks
Topic |
Description |
---|---|
Alerts |
Juniper Mist-defined alarm events configurable on a per-site basis in the alert framework. |
Audits |
A topic that tracks configuration changes made from the Juniper Mist dashboard. |
Client Information |
The webhook that includes information about each client. |
Client Join |
The webhook that Juniper Mist triggers whenever a client joins a wireless network. |
Client Sessions |
The webhook that includes information about the client sessions. |
Device Events |
A topic that is specific to events that occur on devices (currently AP, switch, and gateway) |
Device Up/Downs |
The topic that generates a message when a device starts up or goes down. |
Mist Edge Events |
The topic that generates messages for a Juniper Mist Edge port and link status changes and link aggregation control protocol (LACP) port and link changes. |
BLE Asset RSSI
The BLE Asset RSSI topic sends telemetry BLE data based on the named asset.