Integrating Auvik with Webex

For more information on editing, deleting, disabling, and enabling integrations, see How do I edit, delete, disable, or enable integrations?

Auvik connects to Webex for alert notifications using an incoming webhook. All of your Auvik alerts will feed into a Webex space. To have alerts sent to multiple spaces, create a new webhook integration for each space you’d like to post to. Webhooks can only be managed from your global site.

• Create a new Webex webhook for Auvik
• Add a new webhook integration in Auvik

Create a new Webex webhook for Auvik

1. Go to the desired Webex space.
2. Click on the settings menu.

3. Select Add Integrations & Bots.
4. Search for webhooks and select Incoming Webhooks Integration by Cisco Systems.

5. Click Connect.
   • Note: You may need to sign in to Webex again to connect the Webex App Hub to your Webex account.

6. Enter a Webhook name.
7. Select a space to send the messages to.

7. Click Add.
8. Click the copy button beside the Webhook URL.
9. Save it for use in the next step.

For details, refer to the Webex Incoming Webhooks app listing.

How to add a new webhook integration in Auvik

1. In Auvik, click Integrations in the side navigation bar.
2. Hover over the Add Integration button.
3. Select Webhook.
4. Enter a name for the integration in Integration name.
5. Enter the API URL that the webhook will call in Webhook URL.
6. Skip Add Additional HTTP headers to send.
7. Set your authentication method to No Authentication.
8. Enter a JSONata expression to transform the webhook payload format to one required by the Webex webhook. The minimum required format to send a message to the webhook is a JSON with a text field as noted in the Webex Incoming Webhooks app listing.

1. • Paste the following in Apply transformation here box. You can refer to the JSONata getting started and documentation for a full guide on JSONata. Refer to the Formatting Messages guide on supported message formats. A more complex example is provided in the next section.

{ 

“text”: alertDescription 

}

• • Substitute with the desired Auvik field names.
    • Use the Example Payload for the list of field names.
  • View the transformed payload in Example Payload, transformed.

8. Click Test Connection to confirm your settings are accurate.
9. Verify that a test message appears in the Webex space.
10. Click Save.

Payload Transformation Example

The Auvik alerting webhook payload and the available fields are detailed in this article. Here is a sample webhook payload transformation that provides more detailed information about the alert and a link to the alert in the Auvik UI.

{

  "markdown": $join(["**", subject, "**\n", alertDescription,"\n\n**Entity Name:** ", entityName, "\n**Entity Type:** ", entityType, "\n**Date/Time (UTC):** ", date,"\n\n[View in Auvik](", link ,")"])

}

The test message in Webex will look something like this:

For more complex transformations, refer to the JSONata documentation. Refer to the Formatting Messages guide on supported message formats. 

Configure a notification channel

Before you can use the webhook integration with Webex, there’s one final configuration step: creating a notification channel to be associated with the Auvik alerts you’d like sent to Webex.