Skip to content
This repository has been archived by the owner on Feb 12, 2022. It is now read-only.

Trigger

textractor edited this page Mar 1, 2018 · 8 revisions

User Guide | Data Model


The trigger object encapsulates information about alert conditions from which to send a notification.

Field Name Type Description
id bigint ID of the trigger object
createdById bigint ID of the principal who created the trigger
createdDate long Timestamp at which the trigger was created
modifiedById bigint ID of the principal who last modified the trigger
modifiedDate long Timestamp at which the trigger was last modified
type string Trigger comparison operator
name string Trigger name
threshold double Operand for the comparison. At least 2 qualifying data points must occur within the inertia window to fire the trigger.
secondaryThreshold double Operand for the BETWEEN and NOT_BETWEEN operators. BETWEEN is inclusive of both operand values, while NOT_BETWEEN is exclusive of those values.
inertia long Number of milliseconds for which the threshold must be violated before the trigger is fired
alertId bigint Alert ID that the trigger is associated
notificationIds bigint[] Notification IDs that the trigger is associated
Example: Trigger Entity
{
  "id": 297689,
  "createdById": 100301,
  "createdDate": 1446163333290,
  "modifiedById": 100301,
  "modifiedDate": 1446163333291,
  "type": "LESS_THAN",
  "name": "My Trigger Name",
  "threshold": 1,
  "secondaryThreshold": -1,
  "inertia": 600000,
  "alertId": 297197,
  "notificationIds": [
    297690
  ]
}