Novu NPM | npm.io

Code-First Notifications Workflow Platform

🚀 Quickstart

npx novu@latest dev

🔥 Flags

flag	long form usage example	description	default value
-p	--port	Bridge application port	4000
-r	--route	Bridge application route	/api/novu
-o	--origin	Bridge application origin	http://localhost
-d	--dashboard-url	Novu Cloud dashboard URL	https://dashboard.novu.co
-sp	--studio-port	Local Studio server port	2022
-sh	--studio-host	Local Studio server host	localhost
-t	--tunnel	Self hosted tunnel url	null
-H	--headless	Run bridge in headless mode	false

Example: If bridge application is running on port 3002 and Novu account is in EU region.

npx novu@latest dev --port 3002 --dashboard-url https://eu.dashboard.novu.co

⭐️ Why

Building a notification system is hard, at first it seems like just sending an email but in reality it's just the beginning. In today's world users expect multichannel communication experience over email, sms, push, chat and more... An ever-growing list of providers are popping up each day, and notifications are spread around the code. Novu's goal is to simplify notifications and provide developers the tools to create meaningful communication between the system and its users.

✨ Features

🌈 Single API for all messaging provide`rs (Email, SMS, Push, Chat)
💅 Easily manage notification over multiple channels
🚀 Equipped with a CMS for advanced layouts and design management
🛡 Built-in protection for missing variables (Coming Soon)
📦 Easy to set up and integrate
🛡 Debug and analyze multichannel messages in a single dashboard
📦 Embeddable notification center with real-time updates
👨‍💻 Community driven

🚀 Getting Started

To start using Novu, run the following command. You'll be guided through the setup process.

npx novu init

After setting up your account using the cloud or docker version you can trigger the API using the @novu/node package.

npm install @novu/node

import { Novu } from '@novu/node';

const novu = new Novu(process.env.NOVU_API_KEY);

await novu.trigger('<TRIGGER_NAME>', {
  to: {
    subscriberId: '<UNIQUE_IDENTIFIER>',
    email: 'john@doemail.com',
    firstName: 'John',
    lastName: 'Doe',
  },
  payload: {
    name: 'Hello World',
    organization: {
      logo: 'https://happycorp.com/logo.png',
    },
  },
});

Embeddable notification center

Using the Novu API and admin panel you can easily add real-time notification center to your web-app without the hassle of building it yourself. You can use our React component or an iframe embed if you are not using React.

Providers

Novu provides a single API to manage providers across multiple channels with a simple-to-use interface.

💌 Email

📞 SMS

📱 Push

FCM
Expo
SNS
Pushwoosh

👇 Chat

Slack
Discord
MS Teams
Mattermost

📱 In-App

Novu

Other (Coming Soon...)

PagerDuty

💻 Need Help?

We are more than happy to help you. Don't worry if you are getting some errors or problems while working with the project. Or just want to discuss something related to the project.