Monitor and alert on triggers, heartbeats, and alarms
Key Features
- Three alert types: Triggers, Heart Beat monitors, and Alarms
- Configurable alert and escalation times
- Tag-based alert organization
- State tracking (OK, Triggered, Escalated)
- Web UI for alert management
Alert Types:
- Trigger** - Fires when specific condition occurs
- Heart Monitor** - Monitors periodic heartbeat signals
- Alarm** - Time-based alarm notifications
Server-Side Usage:
<![CDATA[
// Get the Alert API
var Alert = js.getObject("/OpenForum/AddOn/Alert","Alert.sjs");
// Add an alert
Alert.addAlert("ServerHealth", "heartMonitor", 60000, 300000);
// Trigger an alert
Alert.trigger("ServerHealth");
// Send heartbeat
Alert.beat("ServerHealth");
// Get alerts by tag
var alerts = Alert.getAlerts("production");
]]>
/OpenForum/AddOn/Alert Sevice API Version 1.0.7
Get Actions
Action triggerAlert
Parameters
| Name | Description |
| name (required=true) | {{parameter.description}} |
| reason (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/Alert?action=triggerAlert
Example Response
Example Error Response
Action getTags
Parameters
| Name | Description |
| alertName (required=true) | {{parameter.description}} |
Example Get Request
/OpenForum/AddOn/Alert?action=getTags
Example Response
Example Error Response
Post Actions