Skip to main content

​
The notification method object

​
address
string
required

The address of this method (e.g. redacted phone number, email address, device name, Slack user name)

Example:

"•••••••6789"

​
id
string
required

Unique identifier for this notification method

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

​
is_usable
boolean
required

Whether this method is ready to receive notifications. For phone, this means verified. For app devices, this means push notifications can be sent. For email, Slack, and Microsoft Teams this is always true.

Example:

true

​
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"

​
phone_details
object
Example:
{
  "supports_sms": true,
  "supports_voice": true
}