Message schema Model API Reference (Messages)

Reference the Novu message schema used in API requests and responses. Review fields, data types, and object structure for this resource.

Message

Message is a single notification that is sent to a subscriber. Each channel step in the workflow generates a message.

Prop	Type	Default
`contextKeys?`	`string[]`	-
`overrides?`	`{ [k: string]: any; }`	-
`payload?`	`{ [k: string]: any; }`	-
`errorText?`	`string`	-
`errorId?`	`string`	-
`status?`	`MessageStatusEnum`	-
`feedId?`	`string \| null`	-
`cta?`	`MessageCTA`	-
`title?`	`string`	-
`deviceTokens?`	`string[]`	-
`providerId?`	`string`	-
`directWebhookUrl?`	`string`	-
`phone?`	`string`	-
`email?`	`string`	-
`snoozedUntil?`	`string`	-
`seen?`	`boolean`	-
`read?`	`boolean`	-
`channel?`	`ChannelTypeEnum`	-
`subject?`	`string`	-
`transactionId?`	`string`	-
`content?`	`string \| EmailBlock[] \| null`	-
`lastReadDate?`	`string`	-
`lastSeenDate?`	`string`	-
`deliveredAt?`	`string[]`	-
`createdAt?`	`string`	-
`templateIdentifier?`	`string`	-
`template?`	`WorkflowResponse`	-
`subscriber?`	`SubscriberResponseDto`	-
`subscriberId?`	`string`	-
`notificationId?`	`string`	-
`organizationId?`	`string`	-
`messageTemplateId?`	`string \| null`	-
`environmentId?`	`string`	-
`templateId?`	`string \| null`	-
`id?`	`string`	-

ChannelTypeEnum

ChannelTypeEnum {
  IN_APP = "in_app",
  EMAIL = "email",
  SMS = "sms",
  CHAT = "chat",
  PUSH = "push"
}

Workflow

Workflow is a collection of steps that are executed in order to send a notification.

Prop	Type	Default
`workflowIntegrationStatus?`	`WorkflowIntegrationStatus`	-
`data?`	`WorkflowResponseData`	-
`notificationGroup?`	`NotificationGroup`	-
`deletedBy?`	`string`	-
`deletedAt?`	`string`	-
`deleted?`	`boolean`	-
`parentId?`	`string`	-
`notificationGroupId?`	`string`	-
`triggers?`	`NotificationTrigger[]`	-
`environmentId?`	`string`	-
`creatorId?`	`string`	-
`organizationId?`	`string`	-
`steps?`	`NotificationStepDto[]`	-
`tags?`	`string[]`	-
`critical?`	`boolean`	-
`preferenceSettings?`	`SubscriberPreferenceChannels`	-
`draft?`	`boolean`	-
`active?`	`boolean`	-
`description?`	`string`	-
`name?`	`string`	-
`id?`	`string`	-

Actor

Actor is the user who is skipped from sending the notification when workflow is triggered to a topic.

Prop	Type	Default
`valueOf?`	`(() => string) \| (() => Object)`	-
`toString?`	`(() => string) \| (() => string)`	-

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.

Prop	Type	Default
`action?`	`MessageAction`	-
`data?`	`MessageCTAData`	-
`type?`	`"redirect"`	-