Webhook payload format

Alerts can be received through HTTP web hooks so you can take further actions when alerts get triggered. Each time a notification is triggered, a HTTP POST request will be sent to the URL you specify when configuring the web hook.

Fields

  • alert_section - The top level alert section e.g. System
  • alert_type - The sub type e.g. Load average
  • configured_trigger_value - The value that will trigger this alert from the configuration
  • configured_trigger_location_threshold (services only) - How many monitoring locations the status must exist at before the alert is triggered
  • current_value - The current value of this metric as per the latest value posted back by the agent or through the service monitor request.
  • item_cloud (devices only) - Whether the alert is triggered on a cloud device or not
  • item_id - The ID of the item (device or service) the alert is triggered on
  • item_name - The name of the item (device or service) the alert is triggered on
  • item_type - The type of item (Device or Service) the alert is triggered on
  • trigger_datetime - The time in UTC the alert was triggered
  • triggered_value - The value that triggered the alert (only for devices)
  • fixed - Will be present as true for the final fixed notification, false otherwise
  • alert_id - The ID of the alert that has been triggered
  • incident_id - A unique ID for the alert triggered.

Example Device Alert

The request will include a JSON payload in the HTTP request body:

{

"alert_section": "System",
"alert_type": "Load average",
"configured_trigger_value": 0.78,
"current_value": 0.78,
"item_cloud": false,
"item_id": "5182987c87c9a88c04000021",
"item_name": "mtx2-web1.wdc.sl",
"item_type": "Device",
"trigger_datetime": "2013-07-07 13:34:28",
"triggered_value": 0.78,
"fixed": false,
"alert_id":"52d575043012a5962c8b4569",
"incident_id":"52d575043012a5962c8b4569"

}

Example Service Alert

The request will include a JSON payload in the HTTP request body:

{

"alert_section": "http",
"alert_type": "status",
"configured_trigger_value": "down",
"configured_trigger_location_threshold": 1,
"current_value": {
"USA: Virginia": "down"
},
"item_cloud": false,
"item_id": "50a14f591212ba1b5d0001bb",
"item_name": "Test: Down",
"item_type": "Service",
"trigger_datetime": "2013-09-27 09:09:04",
"fixed": false,
"alert_id":"52d575043012a5962c8b4569",
"incident_id":"52d575043012a5962c8b4569"

}

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

Comments

Monday  —  Friday.

10am  —  6pm UK.

Dedicated Support.