Integrating Auvik with a webhook

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

Auvik can connect to a communication tool for alert notifications using an incoming webhook.

To set up an Auvik integration using a generic webhook, first create the new incoming webhook by following the steps below. Then create the new integration in Auvik.

Note: Unlike our other integrations, the date/time format sent to your webhook for an Auvik alert will appear in UTC/GMT rather than the time zone defined on your Auvik dashboard.

Webhook integrations can only be managed from your MSP dashboard.

How to add a new webhook integration

All of your Auvik alerts will feed into a single webhook. To have alerts sent to multiple webhooks, it’s best to create a new integration for each webhook you’d like to post to.

Webhook URLs must sit behind a secure socket layer (HTTPS).

1. 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. Optional: Add Additional HTTP headers to send
7. Add a Key and Value for each required header
8. Select your authentication method:
   1. No Authentication - No authentication is required
      
   2. Header - An API key is provided through a custom HTTP header
      • Enter the Key and Value
        
   3. Basic Authentication - Enter the Username and Password for the target API
      
   4. OAuth 2.0 - Only the OAuth 2.0 client credential grant type is supported
      
      
      • Enter the Client ID, Client Secret and the Token URL to get the access token
      • The optional Scope field is not supported
9. Optional: Enter a JSONata expression to transform the webhook payload format to one required by the target API
   
   
   • See the example below.
     • Find the payload format of the 3rd party API endpoint for the webhook URL provided above
     • Paste the required payload in Apply transformation here box
       • You can refer to the JSONata getting started and documentation for a full guide
     • Substitute with Auvik field names
       • Use the Example Payload for the list of field names
   • View the transformed payload in Example Payload, transformed
10. Click Test Connection to confirm your settings are accurate
11. Click Save

Payload Transformation Example

The Auvik alerting webhook payload and the available fields are detailed in this article. Suppose the API endpoint that I want to send Auvik alert notifications has this request body format:

{

“title”: “string”,

“message”: “string”

}

If I want to use the Auvik subject field for title and Auvik alertDescription for message, this is the expression to use:

{

“title”: subject,

“message”: alertDescription

}

For more complex transformations, refer to the JSONata documentation.

If the test connection spins or a failed message appears, see How do I troubleshoot issues with my Auvik / Webhook integration? for possible resolutions.

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

If Auvik alerts fail to be sent to your webhook, see How do I troubleshoot issues with my Auvik / Slack integration? for possible resolutions.

See How do I interpret Auvik webhook notifications? for a webhook output example.

See How to associate an external ticket ID to an Auvik alert using webhooks? to learn how to add a link to a corresponding ticket in an external ticket management system in the Auvik UI.