Step 4: Create an Alarm Monitor
At this step, an alarm monitor is created; it will be set up properly later. However, right from the very beginning, the new monitor needs:
- User groups that will have it accessible; these are going to be the groups selected at Step 1.
- Webhook messaging feature enabled with all the data it takes, specifically:
- URL to send the messages to.
- HTTP method to use
- The option to send or not to send event snapshots
To do so:
Run the request ...
| POST Request Sample | |
| /api/v1/alarm-monitors | |
.. with the body holding a CreateAlarmMonitorRequest JSON file, in which the properties of the new monitor are specified.
name Required | string |
maxLength: 64 Alarm monitor's name; it makes sense to give meaningful, self-explanatory names to alarm monitors. | ||
max_event_count Required | integer ($int32) | Top number of alarms on the monitor screen | ||
user_groups Required | Array of integers ($int32) | Identifiers of user groups that will have the monitor accessible. Set equal to those selected at step 1. | ||
webhook | Webhook object | Webhook messaging parameters | ||
| url | string | Webhook recipient's URL | ||
| method | string | HTTP method, one of [GET, HEAD, POST, PATCH, DELETE, OPTIONS, TRACE] | ||
| enabled | boolean | Messaging on/off indicator Set "enabled": true | ||
| send_snapshots | boolean | The option to include ("send_snapshots": true) or not to send ("send_snapshots": false) event snapshots in the webhook messages |
The request returns the AlarmMonitor object to confirm the creation of the new monitor, in which the id is the new monitor's identifier assigned automatically, needed at the next step to properly set up the monitor.