Skip to main content
Novu Framework enables you to run a part of the core Novu workflow engine from within your network boundary. This also opens up a powerful new capability: you can create Novu workflows entirely in code. This is important because:
  • You can inject custom code that does nearly anything you can imagine as part of a Novu workflow
  • Your code-based workflow lives alongside your application code in source control
  • You can hydrate notification content using local data-sources, reducing what you need to sync outside of your IT boundary

What it is and how it works

Novu Framework is an application and SDK that you run locally, and communicates natively with the Novu Cloud Worker Engine via the Novu API. Novu Framework requires a single HTTP webhook-like endpoint (/api/novu or similar) to be exposed by your application. This endpoint is called a Bridge Endpoint and is used to receive events from our Worker Engine through an encrypted client-initiated tunnel. When enabled, Novu Cloud will call the Bridge Endpoint when it needs to retrieve contextual information for a given subscriber and notification. Use the npx novu init command to create a sample Bridge application with a built-in Bridge Endpoint.
Novu Framework is used as a code layer to power both workflows and agents.

Quickstart

To get started with Novu Framework, pick your preferred technology from the list below:
https://mintcdn.com/novu-c5de82d9/KUG8H_50nuRuEv8Z/images/icons/nextjs.svg?fit=max&auto=format&n=KUG8H_50nuRuEv8Z&q=85&s=9df4787635a1342d58a78eb235bcf907

Next.js

https://mintcdn.com/novu-c5de82d9/KUG8H_50nuRuEv8Z/images/icons/express.svg?fit=max&auto=format&n=KUG8H_50nuRuEv8Z&q=85&s=5e1f1c1f739f82363058b2c4dd6bee63

Express.js

https://mintcdn.com/novu-c5de82d9/KUG8H_50nuRuEv8Z/images/icons/remix.svg?fit=max&auto=format&n=KUG8H_50nuRuEv8Z&q=85&s=e1e34fc78ccaa0adfcaad3c7c49c33d9

Remix

https://mintcdn.com/novu-c5de82d9/KUG8H_50nuRuEv8Z/images/icons/nestjs.svg?fit=max&auto=format&n=KUG8H_50nuRuEv8Z&q=85&s=6450d724cf96bf81b8e7386a0efe16fa

NestJS

https://mintcdn.com/novu-c5de82d9/KUG8H_50nuRuEv8Z/images/icons/svelte.svg?fit=max&auto=format&n=KUG8H_50nuRuEv8Z&q=85&s=a198586de950c11f133b467e5cec2632

Svelte

https://mintcdn.com/novu-c5de82d9/KUG8H_50nuRuEv8Z/images/icons/nuxt.svg?fit=max&auto=format&n=KUG8H_50nuRuEv8Z&q=85&s=d2277ae5a7ad702f93e488bc10dc4ad1

Nuxt

H3

Lambda