Quickstart

Create a new workflow by clicking on the Create Workflow button in the workflows page.

• Give your workflow a name (e.g. “User Onboarding”).
• Workflow identifier will be generated automatically (e.g. user-onboarding).
• Add tags (optional) : Tags are a great way to classify and filter workflows for you, and your users.
• Add a description (optional) : Add a description to help you and your team understand the purpose of the workflow.

Every notification workflow starts with at least one channel step. To add a step, click the Plus button (+) in the Workflow Editor.

In the editor, you can customize your workflow with various steps, including Action steps (e.g., Digest and Delay) and delivery channels. Select a delivery channel to begin crafting your workflow.

Workflows can include multiple steps, with each step sending a notification to the user. Steps execute in the order they are added.

Once you’ve added a channel step, you can customize the notification content.

Click “Configure Channel Step Template” in the channel’s edit view to open the Notification Template Editor and start editing.

Each channel has its own template editor, allowing you to customize the notification content for each channel based on the channel’s capabilities.

In this example, we’re using the In-App channel step, so we’re using the In-App template editor.

You’ve Got a New Task Assigned!

Hey {{subscriber.firstName}}, you've been assigned to a new task: {{payload.task_id.title}} 
The deadline is {{payload.task_id.dueDate}}. Click below to view the details and get started.

View Task

{{payload.task_id.url}}

Preview your notification by clicking the Preview button in the Configure Template section of the workflow editor.

You can test your workflow in the editor by clicking the Test Workflow button in the workflow editor.

If you have the In-app channel step in your workflow, you can test your workflow in the editor with the default subscriber_id, you will see the notification in the Inbox section of the Novu dashboard.

Before leaving the Workflow Editor and heading back to your backend, navigate to the Trigger tab.

Here, you can grab a sample payload to use when calling Novu’s API.

Based on the workflow we created, the sample payload will look like this:

{
  "task_id": {
    "title": "{{payload.task_id.title}}",
    "dueDate": "{{payload.task_id.dueDate}}",
    "url": "{{payload.task_id.url}}"
  }
}

At the bottom of the page, you can grab the workflow trigger snippet and add it to your backend.

Now we’re ready to trigger our workflow via the Novu API.

Learn more about how to build workflows

1. Navigate to the Workflows page, click on the 3 dots button on the right side of the workflow you want to promote and click the Sync to Production button.

You should see a success message and the workflow will be synced to production.

At the top of the page, you should see a dropdown to switch from the Development to the production environment.

Once you have switched to the Production environment, you should see the workflows you have synced to production.

Be sure to update your application’s environment variables to point to your Novu Production environment API Secret Keys.

If you are using the in-app channel, you need to update your Application Identifier to point to your Novu Production environment Application Identifier.