Overview

When an alert is triggered, notifications are sent to all of the alert subscribers.

For more information about alerts, please see the Alerts section

The Notifications API allow you to get all sent notifications. We provide the flexibility to filter notifications based on the Alert ID, Notification Type, Notification Recipient, Notification Status, and Location.

Notification Configuration

The notifications object is an array of objects as shown below; each containing the enum of the scheduling type, and two additional attributes - description and title` - that can be used to enrich the messages on the receiving webhook side (in addition to the event values).

Attributes

Description

NotificationType

string: PRIOR, START, END, PUBLISH

The type of notification, whereas the enums follow

  • PRIOR: sending notification before events where the Custom Insights are truthy
  • START: sending notification at the start of events where the Custom Insights are truthy
  • END: sending notification at the start of events where the Custom Insights are truthy (aka all-clear)
  • PUBLISH: sending a notification as soon as weather hazards are issued by authorities, according to the respective Insight Category

Notification Status

Notifications status indicates the status of the notification. Notification status support: sent andacknowledged.