docs/platform/workflow/create-a-workflow.mdx - next - githubmirror/novu

docs/platform/workflow/create-a-workflow.mdx
162 строки6 KB
mintlify[bot]
docs(docs): Apply SEO and metadata best practices (#11797)
06 июл 2026, 14:20
06 июл 2026, 14:20c434df6
---
title: 'Create a Workflow'
description: "Create a Novu workflow in the dashboard and define its identifier, metadata, tags, and initial configuration to start orchestrating multi-channel notifications."
---

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](/api-reference/workflows/create-a-workflow) or define them in code using the [Novu Framework](/framework/introduction#create-a-workflow). This guide focuses on creating workflows in the Novu dashboard.

<Note>
  Workflows can only be created and managed in the development environment. Once created, workflows can be synced to other environments. To learn more, refer to [Environments](/platform/developer/environments#publishable-assets).
</Note>

## 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.

<Tabs>
  <Tab title="From scratch">

<Steps>
  <Step title="Go to the Novu Dashboard">
    Sign in at the [Novu Dashboard](https://dashboard.novu.co).
  </Step>

  <Step title="Navigate to Workflows">
    Open **Workflows** from the left sidebar.
  </Step>

  <Step title="Click Create workflow">
    ![Create a workflow](/images/workflows/create-a-workflow/create-a-workflow.png)
  </Step>

  <Step title="Fill in 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.
        <Note>
          The `workflowId` is required when triggering a workflow and when using [trigger overrides](/platform/integrations/trigger-overrides). It is also used to conditionally display notifications in the [`<Inbox />`](/platform/inbox).
        </Note>
      - **Tags** (Optional): Organize and categorize workflows. Tags can be added later in the workflow editor.
        <Note>
          To learn more about Tags, refer to [workflow tags](/platform/workflow/configure-workflow#tags).
        </Note>
      - **Description** (Optional): Document the workflow’s purpose and behavior for your team. Description can be added later in the workflow editor.
    ![Create workflow](/images/workflows/create-a-workflow/create-workflow.png)
  </Step>

  <Step title="Enable translations (optional)">
    Support multiple locales for this workflow. You can also enable this later in the workflow editor.
    <Note>
      To learn more about translations, refer to [Translations](/platform/workflow/advanced-features/translations).
    </Note>
  </Step>

  <Step title="Create the workflow">
    Review the form, then click **Create workflow**.
  </Step>
</Steps>

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

  </Tab>
  <Tab title="From 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:

<Steps>
  <Step title="Go to the Novu Dashboard">
    Sign in at the [Novu Dashboard](https://dashboard.novu.co).
  </Step>

  <Step title="Navigate to Workflows">
    Open **Workflows** from the left sidebar.
  </Step>

  <Step title="Access templates">
    From the **Workflows** page, you can access templates in two ways:
    - Click the icon on the **Create workflow** button and select **From template**.
    ![Create from template](/images/workflows/create-a-workflow/create-from-template.png)
    - Click **Explore templates**.
    ![Create from explore](/images/workflows/create-a-workflow/create-from-explore.png)
  </Step>

  <Step title="Select a template">
    Browse the template library and pick one that matches your use case.
  </Step>

  <Step title="Create the workflow">
    Review the form, then click **Create workflow**.
  </Step>
</Steps>

  </Tab>
</Tabs>

## 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](/platform/workflow/configure-workflow#workflow-status).
- Configure [channel preferences](/platform/workflow/configure-workflow#channel-preferences) and [payload schema](/platform/workflow/configure-workflow#payload-schema).
- Add, remove, or reorder [steps](/platform/workflow/add-and-configure-steps#add-a-step-to-a-workflow).

### 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.

<Steps>
  <Step title="Find the workflow">
    Locate the workflow on the **Workflows** page.
  </Step>

  <Step title="Open the menu">
    Click the three-dot menu (•••).
  </Step>

  <Step title="Select Duplicate workflow">
  </Step>

  <Step title="Provide a new name and identifier">
    ![Duplicate a workflow](/images/workflows/create-a-workflow/duplicate-workflow.png)
  </Step>

  <Step title="Confirm duplication">
    ![Duplicate workflow](/images/workflows/create-a-workflow/duplicate-a-workflow.png)
  </Step>
</Steps>

### Delete a workflow

<Warning>
  Deleting a workflow is permanent and cannot be undone. Any existing triggers referencing the deleted workflow will fail with a `workflow not found` error. Execution history is preserved in the [Novu Activity Feed](/platform/workflow/monitor-and-debug-workflow).
</Warning>

<Steps>
  <Step title="Find the workflow">
    Locate the workflow on the **Workflows** page.
  </Step>

  <Step title="Open the menu">
    Click the three-dot menu (•••).
  </Step>

  <Step title="Select Delete">
  </Step>

  <Step title="Confirm deletion">
    Review the warning, then confirm to permanently delete the workflow.
  </Step>
</Steps>