Meraki Webhooks

Introduction

This page allows you to copy Meraki alert settings (and create Webhooks that send payloads into an AlertMagic integration) from one Organization's network, to other networks in the same Organization.

If, and only if, you have an Alert Management System (AMS) set up, using a Meraki Connection, you will see the Meraki sub-menu item underneath the Webhooks menu.

If you do not see it, you will first need to create a Meraki Connection in the Admin app, then create a new AMS in AlertMagic and choose the Connection you just created.

Prerequisites

To configure Meraki Webhooks, the prerequisites described below must be satisfied.

1. You must have at least one Meraki Connection that can be accessed by AlertMagic
   • Create one in the Admin app (Tenant Admins only)
   • Ensure that you check the "AlertMagic Access" checkbox on the Connection
2. At least one Meraki Connection must not be read-only
   • Ensure that the "Read Only" checkbox is not ticked on the Connection. It is ticked by default on a new Connection
   • Ensure that if the Connection's Configuration field is populated, that the "ReadOnly" property is not set to true. It overrides the "Read Only" checkbox
   • Write access is required in order to create Webhooks via the Meraki API
   • See the Connections help page in the Admin app for more details about both settings
3. You must have at least one Alert Management System (AMS) that uses one of the Meraki Connections
   • Go to the Alert Management Systems page in AlertMagic to create a new AMS
4. You must have at least one Issue Management System (IMS)
   • This is required to create an Integration (requirement #5)
   • Go to the Issue Management Systems page in AlertMagic to create a new IMS
5. You must have at least one Integration that has a Meraki AMS and any type of IMS
   • The Integration is required because it contains AlertMagic credentials required to configure the Webhooks

Creating the Webhooks

There is a step-by-step process with 7 steps to follow, as outlined below. Steps are only shown as you progress from one stage to the next. You also have the ability to set or remove alerting, and to do a dry run (to see what would happen, but without making any changes), or to execute.

At the bottom of the page, the Output Logs section prints out (newest at the top) any messages that occur during the dry run or execution, so you can see what changes were made or any errors that occured.

Step 1: Select an Integration

In order to begin you must choose an Integration. The Integration should be one that has your Meraki AMS configured, and must be selected because it contains the details that the Webhook will need to connect back to the AlertMagic system.

(Coming in version 4.5) Only Integrations that use a Meraki AMS are listed, and the one selected when the page opens is always one of these.

Step 2: Select a Connection

Choose the Meraki Connection that you want to use. The Connection is normally the Meraki Connection as used by the AMS, and is selected for you when you choose an Integration. However, you can choose another one if you wish, for example if you use a separate API key to configure Webhooks. If you do, a warning appears beneath the Connection so that the difference is not missed.

The Connection's validity is shown next to the section heading (e.g. Valid, or Invalid). If it is invalid, the tooltip will highlight the reason why.

(Coming in version 4.5) Read-only Connections are listed as well, marked "(read only)", and show a padlock and an explanation when selected. A read-only Connection cannot create Webhooks, so the Execute mode is unavailable while one is chosen, but you can still use Dry Run with it to see what would happen. The explanation tells you which of the two settings made the Connection read-only, so you know what to change.

Step 3: Find Organizations

All you need to do is hit the Go button, to find Organizations that the Meraki Connection has access to (by virtue of the URL and API key used). Once the Organizations have been found, Step 4 will appear in the UI.

Step 4: Select Organizations

Choose any of the Organizations listed in the dropdown. You may choose multiple ones. Click the Apply button in the drop-down, and it will find relevant Networks in the selected Organizations, and show you the next step (Step 5 - Exemplar Network).

Step 5: Choose Exemplar (source) Network

The exemplar network is the source Network, that already has Meraki alert settings. You may choose only one network, as the source. It's alert settings will be copied to the networks selected in the next step.

Step 6: Select (destination) Networks

Choose the destination Networks for which you want to copy the alert settings to, and create Webhooks for. Once you have done this, you will be able to move on to Step 7 (Actions) and either do a dry run or execute the actions.

Step 7: Actions

There are two modes - Dry Run and Execute, as well as 2 Actions - Remove Alerting and Set Alerting.

Dry Run only reads from Meraki and never changes anything, so it can be used with any Connection. Execute makes the changes, so it needs a Connection that is not read-only. (Coming in version 4.5) Execute is unavailable while a read-only Connection is selected.

An output log of all actions is shown underneath, at the bottom of the page. Click the Go button to begin the process. Once it has started, various log messages will appear, indicating what actions would happen (in Dry Run mode), or are being execute (in Execute mode).

You may also cancel the process while executing, by clicking the Cancel button.

Configuring Meraki

To configure Meraki, you will need to set up per-Network Webhooks and Payload templates. Full information can be found here: https://github.com/meraki/webhook-payload-templates/tree/main/alertmagic.

Key information:

• URL for production: pdl-alertmagic-production.azurewebsites.net/api/notify
• Shared Secret: <Base64encode: "username:password">