How can we help?

How do I interpret webhook notifications?

Follow

How do I interpret Auvik webhook notifications?

 

Webhook notifications are sent when an alert associated with the webhook notification channel has been either triggered or cleared. The format of the notification is JSON. Here’s a description of the fields in the notification.

Note: All IDs are the same as the ones referenced by Auvik APIs.

Field Name

Description

alertDescription

Description of the alert notification

alertId

Unique API identifier of the alert

alertName

Name of the alert

alertSeverity

Numerical value of the alert severity: 1=Emergency, 2=Critical, 3=Warning, or 4=Informational

alertSeverityString

String representation of the alert severity: “Emergency,” “Critical,” “Warning,” or “Info.”

alertStatus

Numerical value of the alert status: 0=Triggered or 1=Cleared

alertStatusString

String representation of the alert status: “Triggered” or “Cleared”

companyId

Unique API identifier of the site the asset is located in

companyName

Name of the site the asset is located in

correlationId

Unique API identifier of the alert trigger. Can be used to dismiss the alert using the Auvik API.

date

Date that the event occurrence was detected. The format used is yyyy-MM-dd'T'HH:mm:ss.SSSXXX. The date sent in UTC time.

entityId

Unique API identifier of the asset that triggered the alert

entityName

Name of the asset that triggered the alert

entityType

Type of the asset that triggered the alert: “device.” “interface,” “network,” or “service.”

link

URL of the alert notification in Auvik

subject

Subject of the alert notification

Below is a sample of a triggered alert webhook notification and a cleared alert webhook notification.

Triggered alert webhook notification:

{
    "entityId": "MTI3Mzg5NDYxMjM5NzQsNDczNjQ5ODI3NjQ3OTI=",
    "subject": "You have a new alert!",
    "alertStatusString": "Triggered",
    "alertId": "MTI3Mzg5NDYxMjM5NzQsNTI4NzY0OTgyNzM2NA==",
    "alertName": "Firewall is online (webhook)",
    "entityName": "Auvik's SonicWall 2400",
    "companyName": "Nanook",
    "entityType": "device",
    "date": "2016-11-15T15:39:13.719Z",
    "link": "https://nanook.my.auvik.com/alert/193884525816632836/summary",
    "alertStatus": 0,
    "alertDescription": "Firewall is online (webhook)",
    "alertSeverityString": "Emergency",
    "alertSeverity": 1,
    "companyId": "191992599575398404",
    "correlationId": "MTI3Mzg5NDYxMjM5NzQsNTI4NzY0OTgyNzM2NA=="
}

Cleared alert webhook notification:

{
    "entityId": "MTI3Mzg5NDYxMjM5NzQsNDczNjQ5ODI3NjQ3OTI=",
    "subject": "You have a new alert!",
    "alertStatusString": "Cleared",
    "alertId": "MTI3Mzg5NDYxMjM5NzQsNTM1MzQzNjM0MzQz",
    "alertName": "Firewall is online (webhook)",
    "entityName": "Auvik's SonicWall 2400",
    "companyName": "Nanook",
    "entityType": "device",
    "date": "2016-11-15T15:54:32.114Z",
    "link": "https://nanook.my.auvik.com/alert/193884525816661508/summary",
    "alertStatus": 1,
    "alertDescription": "Device Online Status is now not equal to Offline",
    "alertSeverityString": "Info",
    "alertSeverity": 4,
    "companyId": "191992599575398404",
   "correlationId": "MTI3Mzg5NDYxMjM5NzQsNTI4NzY0OTgyNzM2NA=="

} 

 

}




Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request