Quick Start

​

Introduction to Novu Framework

Novu Framework allows you to write notification workflows in your codebase. Workflows are functions that execute business logic and use your preferred libraries for email, SMS, and chat generation. You can use Novu Framework with React.Email, MJML, or any other template generator.

​

Try it now

To create a new Bridge application that will allow you to define your workflow in code, open your terminal and execute the create-novu-app command.

npx create-novu-app@latest --api-key=<API_KEY_HERE>

The command will ask you if you wish to install from a React.Email template or a clean project.

​

Core features

​

How it Works?

Novu Framework introduces a new paradigm when working with Novu. Rather than defining workflows and templates at Novu Cloud, Novu Framework enables you to work in your application, use your own libraries and connect to your production environment during workflow execution over HTTPS.

The Novu Framework exports the client you use to define and serve your workflows and their steps over HTTPS. The workflows can be added to your preferred framework. During workflow execution Novu Cloud makes HTTPS requests to your Bridge server for just-in-time Content and Subscribers resolution.

​

For Non-Technical Users

Novu Framework was built with non-technical user in mind. Engineers can write complex workflows and expose a type-safe Inputs interface powered by JSON-Schema. This enables Non-Technical teammates to safely modify the workflow without breaking mission critical notifications.