Grouping actions is recommended for escalations for different types of alert instances. If you don't need this functionality, set it to default.
idstringrequired
The ID of the action saved object.
paramsobjectrequired
The map to the params that the action type will receive. params are handled as Mustache templates and passed a default set of context.
alertTypeIdstringrequired
The ID of the alert type that you want to call when the alert is scheduled to run.
consumerstringrequired
The name of the application that owns the alert. This name has to match the Kibana feature name, as that dictates the required role-based access control privileges.
enabledboolean
Indicates if you want to run the alert on an interval basis after it is created.
The parameters to pass to the alert type executor params value. This will also validate against the alert type params validator, if defined.
scheduleobjectrequired
The schedule specifying when this alert should be run. A schedule is structured such that the key specifies the format you wish to use and its value specifies the schedule.
intervalstring
The interval format specifies the interval in seconds, minutes, hours or days at which the alert should run.
tagsstring[]
A list of keywords to reference and search.
throttlestring
How often this alert should fire the same actions. This will prevent the alert from sending out the same notification over and over. For example, if an alert with a schedule of 1 minute stays in a triggered state for 90 minutes, setting a throttle of 10m or 1h will prevent it from sending 90 notifications during this period.