Documentation

Alerts Webhook Reference


Appsee's alerts are only available in our Premium and Enterprise Plans. If you don't have access to the server API please contact us.

When an alerts is triggered, an HTTP POST request will be sent to the endpoint defined in the alert "Actions" section, containing the following JSON in the HTTP body:

Alert JSON Object

Field   Description
Alert The alert name
Description Textual description of the current trigger
TriggerCount Number of times that the alert was triggered (including the current trigger)
TriggerTime The datetime of the current trigger
Can be a date ('yyyy-mm-dd' : '2014-11-23') or a UTC time ('yyyy-mm-ddTHH:MM:SS' : '2014-11-23T13:09:08')
LastTriggerTime Optional The datetime of the last trigger (before the current one)
Can be a date ('yyyy-mm-dd' : '2014-11-23') or a UTC time ('yyyy-mm-ddTHH:MM:SS' : '2014-11-23T13:09:08')
Test Optional True if it is a test trigger
Session Optional The session object that triggered the alert (for "A Session Crashes" alert only)
MetricValue Optional The current metric value (for "A Metric Changes" alert only)
MetricThreshold Optional The threshold defined in the alert (for "A Metric Changes" alert only)
CurrentState Optional An object describing the current state (for "A Metric Changes" alert only)
  StartTime Start time of the period that the alert was evaluated for
Can be a date ('yyyy-mm-dd' : '2014-11-23') or a UTC time ('yyyy-mm-ddTHH:MM:SS' : '2014-11-23T13:09:08')
  EndTime End time of the period that the alert was evaluated for
Can be a date ('yyyy-mm-dd' : '2014-11-23') or a UTC time ('yyyy-mm-ddTHH:MM:SS' : '2014-11-23T13:09:08')
  Value The metric value of the current period
PreviousState Optional An object describing the previous state (for "A Metric Changes" alert only)
  StartTime Start time of the previous period that the alert was evaluated for
Can be a date ('yyyy-mm-dd' : '2014-11-23') or a UTC time ('yyyy-mm-ddTHH:MM:SS' : '2014-11-23T13:09:08')
  EndTime End time of the previous period that the alert was evaluated for
Can be a date ('yyyy-mm-dd' : '2014-11-23') or a UTC time ('yyyy-mm-ddTHH:MM:SS' : '2014-11-23T13:09:08')
  Value The metric value of the previous period

JSON format example:
{ "Alert": "My Critical Alert", "Description": "% Crash changed by more than 10%", "MetricValue": 100.0, "MetricThreshold": 15.0, "TriggerTime": "2017-06-14", "TriggerCount": 2, "LastTriggerTime": "2017-04-21", "Test": true, "CurrentState": { "EndTime": "2017-06-14", "Value": 20.0, "StartTime": "2017-06-14" }, "PreviousState": { "EndTime": "2017-06-13", "Value": 10.0, "StartTime": "2017-06-13" } }