For more information on editing, deleting, disabling, and enabling integrations, see How do I edit, delete, disable, or enable integrations?
Auvik connects to Discord for alert notifications using an incoming webhook. All of your Auvik alerts will feed into a Discord channel. To have alerts sent to multiple channels, create a new webhook integration for each channel you’d like to post to. Webhooks can only be managed from your global site.
- Create a new Discord webhook for Auvik
- Add a new webhook integration in Auvik
Create a new Discord webhook for Auvik
- Go to the desired Discord channel.
- Click on the settings icon beside the channel name.
- Select Integrations.
- Click on Create Webhook.
- Click on New Webhook.
- Select the context menu (>) for the webhook.
- Provide a name for the webhook.
- Select the channel to post to.
- Click Copy Webhook URL.
- Save the webhook URL for use in the next step.
For details, refer to Discord’s Intro to Webhooks article.
How to add a new webhook integration in Auvik
- In Auvik, click Integrations in the side navigation bar.
- Hover over the Add Integration button.
- Select Webhook.
- Enter a name for the integration in Integration name.
- Enter the API URL that the webhook will call in Webhook URL.
- Skip Add Additional HTTP headers to send.
- Set your authentication method to No Authentication.
- Enter a JSONata expression to transform the webhook payload format to one required by the Discord API. The minimum required format to send a message to Discord webhook is a JSON with a content field as noted in the Discord Message structure reference.
-
- 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 Discord Message structure reference on supported message content types. A more complex example is provided in the next section.
{
“content”: 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.
- Substitute with the desired Auvik field names.
- Click Test Connection to confirm your settings are accurate.
- Verify that a test message appears in the Discord channel.
- 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.
{
"embeds": [
{
"title": subject,
"description": $join([alertDescription,"\n\nEntity Name: ", entityName, "\nEntity Type: ", entityType, "\nDate/Time (UTC): ", date])
},
{
"title": "View in Auvik",
"url": link
}
]
}
The test message in Discord will look something like this:
For more complex transformations, refer to the JSONata documentation. Refer to Discord Message structure reference on supported message content types.
Configure a notification channel
Before you can use the webhook integration with Discord, there’s one final configuration step: creating a notification channel to be associated with the Auvik alerts you’d like sent to Discord.