Create a Workflow

A workflow defines how Novu delivers notifications for a specific event. It contains the steps, templates, and rules that control how messages are sent across channels.

You can create workflows in the Novu dashboard, using the Novu API or define them in code using the Novu Framework. This guide focuses on creating workflows in the Novu dashboard.

Create a workflow

You can create a Novu workflow in the following ways:

• Create from scratch: Build a custom workflow tailored to your exact needs.
• Create from template: Start with pre-built workflows for common use cases.

Create a workflow from scratch

1. Go to the Novu Dashboard.
2. Navigate to Workflows.
3. Click Create workflow.
   
4. Fill in the workflow details:
   • Name (Required): The display name shown in the dashboard. You can change this later in the workflow editor.
   • Identifier (Required): The workflowId is immutable. It must be in a valid slug format (letters, numbers, hyphens, dots and underscores only) and must be unique within one environment.
     The workflowId is required when triggering a workflow and when using trigger overrides. It is also used to conditionally display notifications in the <Inbox />.
   • Tags (Optional): Organize and categorize workflows. Tags can be added later in the workflow editor.
     To learn more about Tags, refer to workflow tags.
   • Description (Optional): Document the workflow’s purpose and behavior for your team. Description can be added later in the workflow editor.
5. Enable translations (Optional): Support multiple locales for this workflow. This can be enabled after workflow creation in the workflow editor.
   To learn more about translations, refer to Translations.
6. Click Create workflow.

After creating the workflow, you’re redirected to the Workflow Editor, where you can configure the workflow and add steps.

Create a workflow from a template

Templates are pre-built workflows for common notification scenarios. They include pre-configured steps, sample content, and pre-filled workflow details that you can customize.

To create a workflow from a template:

1. Go to the Novu Dashboard.
2. Navigate to Workflows.
3. From the Workflows page, you can access templates in two ways:
   • Click the icon on the Create workflow button and select From template.
   • Click Explore templates.
4. Select a template.
5. Click Create workflow.

Manage workflows

Once created, you can manage workflows from the Workflows page:

Update a workflow

After creating a workflow, you can modify its configuration at any time from the workflow editor. This allows you to evolve notification logic without creating a new workflow.

Click on any workflow to open the workflow editor, where you can:

• Update name and description (identifier cannot be changed)
• Add or remove the workflow tags.
• Change workflow status.
• Configure channel preferences and payload schema.
• Add, remove, or reorder steps.

Duplicate a workflow

Duplicating a workflow lets you reuse an existing configuration as a starting point for a new workflow. This is useful when workflows share similar logic but differ in trigger identifiers, content, or steps.

1. Find the workflow in Workflows page.
2. Click the three-dot menu (•••).
3. Select Duplicate workflow.
4. Provide a new name and identifier.
5. Click Duplicate Workflow.

Delete a workflow

1. Find the workflow in Workflows page.
2. Click the three-dot menu (•••).
3. Select Delete.
4. Confirm deletion.