Skip to main content

​
Introduction

This guide will walk you through how to send notifications with MJML and Novu. You can check out the code for a sample demo app.

​
Pre-requisites

  • A Novu account
  • Node installed on your machine
  • A working NextJS development environment

​
Get started with Novu Framework

Novu Framework is a “notifications as code” approach that enables developers to define workflows as functions and integrate them with their preferred libraries for email, SMS, and chat generation.
  1. To get started with Novu Framework, just run this command in your terminal, it’ll scaffold a new NextJS project with Novu Framework and we’ll be ready to roll!
  1. Once you execute this command, you’ll be asked to give your project a name. I’ll keep the default my-novu-app but you can choose your own.

Give your app a name

  1. You’ll then be asked if you want to use React-email or not. Since, we’ll be using MJML, I’m choosing the default ‘No’ option.

Choose if you want to install React email or not

  1. After this step, all the dependencies will be installed and you will be able to start using Novu Framework.

Let all the dependencies get installed

  1. Once this installation is complete, simply cd into the directory and start your app using the npm run dev command, and your app will be served on localhost:4000
Make sure that the port 4000 isn’t already being used!
You’ll now have a NextJS app running on http://localhost:4000 and you can make changes to your app as you see fit. Let’s now move to the meaty stuff - using Novu Framework in a NextJS app and the magic of Dev Studio.

​
Echo Dev Studio

The Echo Dev Studio is a companion app to the Echo Client SDK. Its goal is to provide a local environment that lives near your code. To launch the dev studio locally you can run: npx novu-labs@latest echo. The Dev Studio will be started by default on port 2022, and accessible via: http://localhost:2022

Echo Dev Studio runs on 'localhost:2022' by default. Here I’m already using port 2022 so it is starting on a different port but we recommend ensuring that port 2022 is free

Here’s how the Dev Studio looks on the first run:

Echo Dev Studio on the first run

You’ll notice that it asks for an Echo endpoint at the bottom. Novu Echo requires a single HTTP endpoint (/api/echo or similar) to be exposed by your application. This endpoint is used to receive events from our Worker Engine. We have more on Novu endpoint in our docs.
You can view the Echo Endpoint as a webhook endpoint that Novu will call when it needs to retrieve contextual information for a given subscriber and notification.
Just enter the full URL of your Echo Endpoint. In our case, it is http://localhost:4000/api/echo

Enter Echo endpoint URL

Once you do, you’ll see a green checkmark alongside the URL input box and a green connected highlight at the top right corner.

​
Installing and configuring MJML

Integrating MJML with Novu in our NextJS app is quite straightforward, with just one small caveat. Following are the steps to get it installed and configured:
  1. Simply run the following command to install it like any other npm package:
Once installed, you need to keep in mind that, MJML doesn’t play very nice with newer web technologies such as Next.js that we’re using today. In order to overcome some hurdles, we need to use the require statement when importing MJML in our files, such as when defining the template.
  1. To write an email template, you can look over some of the examples in the MJML documentation to get inspiration from. In our case, this is the template:
  1. And as final step, we need to define the workflow that uses the template defined above.
Once you do this, you’ll see this workflow, the steps in the workflow, step inputs, payload variables and the rendered view of this workflow on the Echo Dev Studio:

Echo Dev Studio now picks up the workflow we just created

Here, from the Dev Studio, you or your peers can change things like the text of a button, toggle visibility of a button, static text content etc and have it synced with the cloud with the Sync to Cloud button.

​
Payload vs Step Inputs

Notice that in the Echo dev studio above, we’ve used payload as well as step inputs. Here’s how you can decide if you need either or both:

​
Syncing with the cloud, with the click of a button

Once done with the workflow, now we need to sync it to the cloud. Fortunately, Novu Framework makes it a breeze to sync changes from the local machine to the cloud and it all happens with a click of a button. To enable our cloud environment to talk to your local Bridge instance, you need to supply an Bridge endpoint URL. This sets up a communication channel between our cloud environment and your local instance. To allow Novu to communicate with your local machine a tunnel will need to be generated. The create-novu-app command sets up localtunnel for you. Running the npm run dev script in the project launches both the Bridge application and the tunnel solution. The tunnel URL shows up in the console output. You can also use a tool like ngrok:
In our case, the app is running on port 4000 so we’ll use:
This will create a tunnel and you’ll see something like this in the terminal:

ngrok has done its magic

Remember, the exact URL (/api/novu or similar) you expose in your application for handling Novu Framework requests is what you’d consider the Bridge URL. This URL would be the endpoint within your application’s domain where Novu’s Worker Engine sends requests to fetch notification content or subscriber details dynamically. In our case, it is this: https://faec-2409-40f2-3c-3b57-400e-a7f7-1fc0-1e5.ngrok-free.app/api/echo So, we’ll enter this Bridge URL:

Enter the Echo URL in the Dev Studio

And create diff:

Echo Dev Studio will create a diff for you

​
Testing our workflow

Once you’ve synced your changes in the previous step, you’ll see a notification that says ‘Sync complete’ and you can now go to Novu Cloud using the ‘Test your workflows’ link and trigger a notification.

Test your workflow will take you to Novu Cloud

You’ll see the workflow you’ve created has a blue lightning bolt icon. That icon signifies that the corresponding workflow has been created with Novu Framework:

You'll see the workflow created using Echo with the blue lightning bolt icon

Simply open the workflow and you can send a test email from there.
Make sure that all the expected payload variables and step inputs are being sent in their respective fields!

Enter the respective data and test your workflow

This is the workflow test email in my inbox:

Workflow test email in my inbox

Once tested, you can simply have this workflow triggered whenever you want. For instance, a typical use case is to have a workflow triggered when an event occurs. To replicate it, I’ve attached a handler function that triggers this workflow when the submit event fires: Here’s a simple replication of the stipulated scenario:
And the corresponding route it hits:
So there you go! This is how you create workflows using Novu Framework and deploy your changes seamlessly to the Novu cloud. You can check out the code for a sample demo app. Once you’ve built the workflow, you might want read one of our other guides on how to empower product teams to manage notification workflows. Don’t forget to share your workflows with us and as always, hit us up on Discord with any questions you might have!