Skip to main content

​
The notification rule object

​
id
string
required

Unique identifier for this notification rule

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
method_target
object
required
Example:
{
  "all": {},
  "specific": { "id": "01FCNDV6P870EA6S7TK1DSYDG0" },
  "type": "specific"
}
​
method_type
enum<string>
required

The high-level type of notification method. Phone rules include phone details that distinguish SMS from voice calls.

Available options:
app,
email,
microsoft_teams,
phone,
slack,
whatsapp_message
Example:

"app"

​
rule_type
enum<string>
required

The urgency level this rule applies to

Available options:
high_urgency,
low_urgency
Example:

"low_urgency"

​
app
object
Example:
{
  "push_notification_criticality": "critical"
}
​
delay_seconds
integer<int64>

Delay in seconds before this rule activates. 0 means immediate.

Required range: 0 <= x <= 1200
Example:

0

​
phone
object
Example:
{ "channel": "voice" }