Skip to content

NotificationInterfaceNotificationMessage

HTTP API schema

← HTTP API reference

A notification delivered to target users, with its title, body, priority and delivery channels.

NotificationInterfaceNotificationMessage fields

notificationIdstring

Unique identifier for this notification

minLength: 1

titlestringRequired

Notification title

minLength: 1

maxLength: 200

bodystringRequired

Notification body text

minLength: 1

maxLength: 2000

prioritystring

Notification priority level

Allowed values: LOW, NORMAL, HIGH, URGENT.

channelsarray<string>

Channels to send the notification through

targetUsersarray<string>

List of user IDs to send the notification to

metadataobject

Additional metadata for the notification

View source specification ↗