This page goes over the properties that define an alarm. The headings correspond to headings on the page to create an alarm.
|Name||A friendly label to use within Hithub|
|Description||Make any additional notes here|
|Status||The status allows you to effectively turn off a sensor (on Hithub). With a status of "inactive", if any hits are attempted for the sensor, they will receive an HTTP 423 (Locked).|
|Sensors||Specify which sensors this alarm should observe events for|
|Number of Events||The minimum number of events to find|
The time frame to look for events relative to when the alarm runs.
For example, if the alarm runs at 5:00 pm and the time frame is set
to 10 minutes, then Hithub will look for events from 4:50 pm to 5:00 pm.
This also determines how often the alarm runs. Basically if the time frame is under 1 hour, the alarm will be checked on those intervals. If the time frame is over an hour, the alarm will be checked once an hour.
Event count for each sensor: The number of events specified
must be found for each sensor specified to trigger the alarm.
Event count of any single sensor: The number of events specified must be found for any one of the sensors specified to trigger the alarm.
Event sum of all sensors: The number of events specified must be found among all the sensors specified to trigger the alarm.
|Custom Variables||See the Sensor Interaction page for details on how to pass variables in events. If required, you may specify criteria to filter events in or out by these variables.|
|Schedule Time||If you want the alarm to only run during a certain time range, specify that here. You may also specify an inverse range. Use 24 hour format.|
|Schedule Day||Leave blank to run on all days, or specify only certain days to run the alarm.|
|Users||Optionally, specify which users should be notified when the alarm is triggered. An email will be sent to these users containing a list of event times which triggered the alarm.|
|Reset Time||Specify the amount of time after an alarm is triggered until the alarm should be checked again.|
If something is not clear, please contact us