Message
Message is a single notification that is sent to a subscriber. Each channel step in the workflow generates a message.string
Unique identifier for the message
string
Template ID associated with the message
string
Environment ID where the message is sent
string
Message template ID
string
Organization ID associated with the message
string
Notification ID associated with the message
string
Subscriber ID associated with the message
SubscriberResponseDto
Subscriber details, if available
WorkflowResponse
Workflow template associated with the message
string
Identifier for the message template
string
Creation date of the message
string[]
Array of delivery dates for the message, if the message has multiple delivery dates, for example after being snoozed
string
Last seen date of the message, if available
string
Last read date of the message, if available
string | EmailBlock[]
Content of the message, can be an email block or a string
string
Transaction ID associated with the message
string
Subject of the message, if applicable
ChannelTypeEnum
Channel type through which the message is sent
boolean
Indicates if the message has been read
boolean
Indicates if the message has been seen
string
Date when the message will be unsnoozed
string
Email address associated with the message, if applicable
string
Phone number associated with the message, if applicable
string
Direct webhook URL for the message, if applicable
string
Provider ID associated with the message, if applicable
string[]
Device tokens associated with the message, if applicable
string
Title of the message, if applicable
MessageCTAType
Call to action associated with the message
string
Feed ID associated with the message, if applicable
MessageStatusEnum
Status of the message
string
Error ID if the message has an error
string
Error text if the message has an error
{ [k: string]: any; }
The payload that was used to send the notification trigger
{ [k: string]: any; }
Provider specific overrides used when triggering the notification
string[]
Context (single or multi) in which the message was sent
ChannelTypeEnum
Workflow
Workflow is a collection of steps that are executed in order to send a notification.string
string
string
boolean
boolean
SubscriberPreferenceChannels
boolean
string[]
NotificationStepDto[]
string
string
string
NotificationTrigger[]
string
string
boolean
string
string
NotificationGroup
WorkflowResponseData
WorkflowIntegrationStatus
Actor
Actor is the user who is skipped from sending the notification when workflow is triggered to a topic. Actor can be a string (subscriber ID) or a SubscriberPayloadDto object with the following fields:string
Unique identifier of the subscriber
string | null
First name of the subscriber
string | null
Last name of the subscriber
string | null
Email address of the subscriber
string | null
Phone number of the subscriber
string | null
Avatar URL or identifier
string | null
Locale of the subscriber
string | null
Timezone of the subscriber
{ [k: string]: any; } | null
Additional custom data associated with the subscriber
MessageCTA
MessageCTA is a call to action that is displayed in the Inbox message. It can be used to redirect the user to a specific URL when the message is clicked.redirect
Type of call to action
MessageCTAData
Data associated with the call to action
MessageAction
Action associated with the call to action