Novu

Novu Framework (Code-First Workflows)

Code-first workflow framework that lets developers define notification workflows in TypeScript / JavaScript using `@novu/framework`, then sync them to Novu Cloud (or a self-hosted instance) via the `npx novu-sync` CLI or the `novuhq/actions-novu-sync` GitHub Action. Supports Express, Next.js, NestJS, Remix, SvelteKit, Nuxt, H3, AWS Lambda, and any node-runtime HTTP handler. The framework owns the workflow source-of-truth — the Dashboard editor stays in sync via a deterministic bridge URL.

Novu Framework (Code-First Workflows) is one of 5 APIs that Novu publishes on the APIs.io network.

Tagged areas include Framework, Code First, Workflows, TypeScript, and Next.js. The published artifact set on APIs.io includes API documentation, a quickstart, SDKs, and code examples.

GitHub

Documentation

📖
Documentation
https://docs.novu.co/framework/overview
📖
Quickstart
https://docs.novu.co/framework/quickstart/nextjs

SDKs

📦
SDK
@novu/framework

Code Examples

💻
CodeExamples
Next.js + React Email
💻
CodeExamples
Remix
💻
CodeExamples
Nuxt
💻
CodeExamples
Nuxt + VueEmail
💻
CodeExamples
Newsletter App

Other Resources

🔗
CLI
npx novu-sync

API entry from apis.yml

apis.yml Raw ↑ 
aid: novu:framework
name: Novu Framework (Code-First Workflows)
description: Code-first workflow framework that lets developers define notification workflows in TypeScript
  / JavaScript using `@novu/framework`, then sync them to Novu Cloud (or a self-hosted instance) via the
  `npx novu-sync` CLI or the `novuhq/actions-novu-sync` GitHub Action. Supports Express, Next.js, NestJS,
  Remix, SvelteKit, Nuxt, H3, AWS Lambda, and any node-runtime HTTP handler. The framework owns the workflow
  source-of-truth — the Dashboard editor stays in sync via a deterministic bridge URL.
humanURL: https://docs.novu.co/framework/overview
baseURL: https://docs.novu.co/framework
tags:
- Framework
- Code First
- Workflows
- TypeScript
- Next.js
- Express
- NestJS
- Remix
- SvelteKit
- Nuxt
- AWS Lambda
properties:
- type: Documentation
  url: https://docs.novu.co/framework/overview
- type: Quickstart
  url: https://docs.novu.co/framework/quickstart/nextjs
- type: SDK
  url: https://www.npmjs.com/package/@novu/framework
  title: '@novu/framework'
- type: CLI
  url: https://www.npmjs.com/package/novu
  title: npx novu-sync
- type: CodeExamples
  url: https://github.com/novuhq/novu-framework-nextjs-react-email-example
  title: Next.js + React Email
- type: CodeExamples
  url: https://github.com/novuhq/novu-framework-remix-example
  title: Remix
- type: CodeExamples
  url: https://github.com/novuhq/novu-framework-nuxt-example
  title: Nuxt
- type: CodeExamples
  url: https://github.com/novuhq/novu-framework-nuxt-vue-email-example
  title: Nuxt + VueEmail
- type: CodeExamples
  url: https://github.com/novuhq/novu-framework-newsletter-app-example
  title: Newsletter App