Workflow schema

Workflow

In Novu, a workflow defines the logic for delivering notifications based on specific events. It consists of configurable steps that control timing, conditions, and which channels to use, such as email, SMS, or in-app messages. Workflows can be built visually in the dashboard or programmatically using the Novu Framework. Each workflow has a unique identifier, supports environment syncing, and provides real-time visibility through the Activity Feed for monitoring and debugging.. Read more about workflows on workflows concept page.

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

⌘I

Getting Started

Notification delivery

Agents

Data

Workflows & content

Platform & channels

Workflow schema

Workflow

​Workflow

Workflow