You can create a Webhook to subscribe to specific Webhook topics to get notified about the events occuring in your Mist Organization or Site. This can either be done from the Mist UI with an API Call.

It is also possible to create multiple Webhook configuration at the org level and/or at the site level. This can be leveraged to send the notifications to different webhook collectors based on their topic.

Depending on the scope (organization or site) where the webhook is configured, different topics can be supported. For more information about the list of supported topics on each scope, see List Webhook Topics.

Configure a Webhook at the Organization levelCopy Anchor Link

When configuring a webhook at the organization level, you be notified for all the events (based on the selected topics) on any of the sites belonging to the Mist Organization. If you want to only receive notification for some sites, it is required to configure the webhooks at the site level.

Configure the Org Webhook from the APICopy Anchor Link

It is possible to use the APIs to create, update, delete, list or get webhooks:

• Create Org Webhook (API Call): Create a new Organization Webhook configuration
• Update Org Webhook (API Call): Update an existing Organization Webhook configuration
• Delete Org Webhook (API Call): Delete an existing Organization Webhook configuration
• List Org Webhooks (API Call): List all the existing Organization Webhook configurations
• Get Org Webhook (API Call): Get a specific Organization Webhook configuration based on its webhook_id

To create a new Webhook Configuration, send a POST /api/v1/orgs/{org_id}/webhooks with the following body:

• the Webhook name
• the Webhook URL (where the webhooks are sent to)
• the list of Webhooks topics from this list

{
    "name": "Webhook One",
    "url": "https://myserver.com:3000/webhook",
    "topics": [
        "audits"
    ]    
}

However, even if this minimum configuration may be enough, we are recommanding to read the Webhook Security page to have a better understanding on how to secure the webhook communications and how you can secure your server by filtering and validating the received HTTP POST messages.

Configure the Org Webhook from the UICopy Anchor Link

See Add a Webhook in the Juniper Mist Portal from the Juniper documentation.

Configure a Webhook at the Site levelCopy Anchor Link

When configuring a webhook at the site level, you be notified for all the events (based on the selected topics) related to the site where the webhook has been configured. The site level webhooks also offer more topics, like the location related notifications.

Configure the Org Webhook from the APICopy Anchor Link

It is possible to use the APIs to create, update, delete, list or get webhooks:

• Create Site Webhook (API Call): Create a new Site Webhook configuration
• Update Site Webhook (API Call): Update an existing Site Webhook configuration
• Delete Site Webhook (API Call): Delete an existing Site Webhook configuration
• List Site Webhooks (API Call): List all the existing Site Webhook configurations
• Get Site Webhook (API Call): Get a specific Site Webhook configuration based on its webhook_id

To create a new Webhook Configuration, send a POST /api/v1/sites/{site_id}/webhooks with the following body:

• the Webhook name
• the Webhook URL (where the webhooks are sent to)
• the list of Webhooks topics from this list

{
    "name": "Webhook One",
    "url": "https://myserver.com:3000/webhook",
    "topics": [
        "audits"
    ]    
}

However, even if this minimum configuration may be enough, we are recommanding to read the Webhook Security page to have a better understanding on how to secure the webhook communications and how you can secure your server by filtering and validating the received HTTP POST messages.

Configure the Site Webhook from the UICopy Anchor Link

See Add a Webhook in the Juniper Mist Portal from the Juniper documentation.