- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
NotificationDTO
A notification's data.
Properties#
idstringThe ID of the notification.
tostringThe recipient of the notification. It can be email, phone number, or username, depending on the channel.
channelstringThe channel through which the notification is sent, such as 'email' or 'sms'
templatestringThe template name in the provider's system.
datanull | Record<string, unknown>The data that gets passed over to the provider for rendering the notification.
provider_idstringThe ID of the notification provider.
providerNotificationProviderDTOInformation about the notification provider
providerNotificationProviderDTOcreated_atDateThe date and time the notification was created.
status"pending" | "success" | "failure"The status of the notification
fromnull | stringOptionalThe sender of the notification. It can be email, phone number, or username, depending on the channel.
Optional attachments for the notification.
trigger_typenull | stringOptionalThe event name, the workflow, or anything else that can help to identify what triggered the notification.
resource_idnull | stringOptionalThe ID of the resource this notification is for, if applicable. Useful for displaying relevant information in the UI
resource_typenull | stringOptionalThe type of the resource this notification is for, if applicable, eg. "order"
receiver_idnull | stringOptionalThe ID of the customer this notification is for, if applicable.
original_notification_idnull | stringOptionalThe original notification, in case this is a retried notification.
external_idnull | stringOptionalThe id of the notification in the external system, if applicable
Was this page helpful?