v1/notification_configs

Use the v1/notification_configs API to create, update, list, and manage configurations that are used for alert notification delivery.

URI

https://<hostname>/ws/v1/notification_configs

Formats

The typical payload for a notification configuration is shown below. This notification configuration indicates that the notification should be sent to the specified team members. The notifications are sent when either the Water Sensor alert occurs or any alert in the NorthWest or SouthWest group occurs.

Additionally, a summary email is delivered to the team members once per day at about 11am Central time.

The id and customer_id fields are read-only and are assigned by the system.

{
    "name": "Send to team",
    "id": 1,
    "customer_id": 2,
    "enabled": true,
  
    "recipients": [
        "user1@example.com",
        "user1@example.com",
        "user3@example.com",
        "user4@example.com"
    ],
  
    "each_alert": true,
  
    "daily_summary": true,
    "at_time": "11:00:00",
    "timezone": "America/Chicago",
  
    "alerts": [
        "Water Sensor"
    ],
    "groups": [
        "NorthWest",
        "SouthWest"
    ]
}

Default values for fields

{
    "name": null,        // The Name field is required
    "id": null,          // set by the system
    "customer_id": null, // set by the system
    "enabled": false,
  
    "recipients": [],
  
    "each_alert": false,
    "daily_summary": false,
    "at_time": "00:00:00",
    "timezone": "UTC",
  
    "alerts": [],
    "groups": []
}

Notification Configuration Data

Each notification configuration stores a variety of information about the notifications that can be sent for alerts. The fields are displayed below.

Except for the name field, all fields are optional, and by default a notification configuration is disabled and will not cause any notifications or target any recipients, groups or alerts.

• alerts - A list of alert names that will cause notifications to be sent. Default is an empty list.
• at_time - The approximate time of day that the daily summary email will be sent. The time is specified in the format HH:MM:SS where HH is the hour in 24-hour format, MM is the minute, and SS is the second. The time is specified in the timezone specified by the timezone field. Default is 00:00:00.
• customer_id - The unique identifier for the customer account. Read-only, generated by the system.
• daily_summary - If true, then a summary email will be sent to each recipient once per day. If false, then a summary email will not be sent to each recipient. Default is false.
• each_alert - If true, then each alert status change will be sent to each recipient. If false, then each alert status change will not be sent to each recipient. Default is false.
• enabled - If true, this notification configuration is enabled and may cause notifications to be sent. If false, this notification configuration is disabled and will not cause notifications to be sent. Default is false.
• groups - A list of group names that will cause notifications to be sent if a triggered alert is associated with the group. Default is an empty list.
• id - The unique identifier for this notification configuration. Read-only, generated by the system.
• name - The name used to distinguish this notification configuration from others in the account. Required.
• recipients - A list of email addresses that will receive notifications. If the each_alert field is true, then each alert will be sent to each recipient. If the daily_summary field is true, then a summary email will be sent to each recipient once per day. Default is an empty list.
• timezone - The timezone used to interpret the at_time field. The timezone is specified using the IANA Time Zone Database format. Default is UTC.