Create an Alert

Body Params
string
required

The name of the alert used by triggered alerts

string
required

ID of a custom insight or pre-defined Severe Weather Event category - e.g. "floods" or ”lightning” for lightning alerts

boolean
Defaults to true

Defines whether the alert triggers notifications to the webhook

json

The configuration of the notifications sent to the webhook (PRIOR, START, and END are available for Insight Alerts and PUBLISH is available for Severe Weather Event Alerts only).

json

configuration of lightning alert with following properties: lightningTypes - an array of possible lightning types based on which alert detection happens. Allowed values: C2C (cloud to cloud) and C2G (cloud to ground). buffers - an array of radiuses based on which the alert detection happens (as soon as lightning strike occurs in one of the buffer, the alert notification is triggered). Minimum buffer value 0.6 and maximum value 48. Note that only first strike within the buffer triggers the alert notification. ttl - duration of all-clear notification since the last strike happen within the buffer distanceUnit - the unit of buffer distance, allowed values km (kilometers) or mi (miles)

Headers
string
Defaults to gzip
Response

Language
Credentials
Query
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json