Scheduling alerts
"schedule" : { "start" : "now", "delay" : "1m", "repeat" : "2h", "end" : "2021-02-01T01:02:03.0Z" }
The following table describes the various parameters that can form a schedule block:
Parameter | Requirement | Default | Description |
---|---|---|---|
start | Mandatory | None | Start time in YYYY-MM-DDTHH:MM:SS.MS[TZ] form or 'now'. Where [TZ] can be 'Z' for GMT or +/-H:MM as per ISO 8601 |
delay | Optional | 1h | Offset from start time to begin 1st (or only) alert in the form {n}{M|w|d|h|m} where M = Months, w = weeks, d = days, h = hours and m = minutes. |
repeat | Optional | No repeat | How often to repeat the alert, in the form {n}{M|w|d|h|m} where M = Months, w = weeks, d = days, h = hours and m = minutes. |
paused | Optional | false | Either “true” or “false. Whether the scheduled alert is paused to begin with |
end | Optional (mandatory if repeat is set) | End time in YYYY-MM-DDTHH:MM:SS.MS[TZ] form, must be specified if repeat is set |