Skip to content
/ novu Public

Open-Source Notification Platform. Embeddable Notification Center, E-mail, Push and Slack Integrations.

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE-ENTERPRISE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

novuhq/novu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

fb4c302 Β· Jul 18, 2023
May 16, 2023
Jun 27, 2023
Aug 7, 2022
May 17, 2023
Apr 11, 2023
Jun 27, 2023
Jul 18, 2023
Jun 14, 2023
Jul 18, 2023
May 15, 2023
Jul 18, 2023
Jul 18, 2023
Jul 18, 2023
Apr 25, 2023
May 25, 2022
Jun 14, 2023
Dec 16, 2022
Nov 7, 2021
Oct 10, 2022
Apr 20, 2023
Apr 25, 2023
Feb 10, 2023
Nov 15, 2022
Jul 9, 2023
Apr 25, 2023
Apr 9, 2023
Oct 22, 2022
Aug 25, 2021
Apr 12, 2022
Aug 19, 2022
Nov 11, 2022
Aug 25, 2021
May 24, 2023
Nov 23, 2022
Sep 23, 2021
Jul 18, 2023
Apr 11, 2023
Apr 12, 2022
Jun 27, 2023
Jul 18, 2023
May 4, 2023
Mar 5, 2023
Jun 29, 2022
Jun 30, 2022

The open-source notification infrastructure for developers

The ultimate service for managing multi-channel notifications with a single API.


Explore the docs Β»

Report Bug Β· Request Feature Β· Join Our Discord Β· Roadmap Β· Twitter Β· Notifications Directory

Available in: Node.js Β· PHP Β· Go Β· Ruby Β· Kotlin Β· Elixir Β· Rust Β· Python

⭐️ Why Novu?

Novu provides a unified API that makes it simple to send notifications through multiple channels, including In-App, Push, Email, SMS, and Chat. With Novu, you can create custom workflows and define conditions for each channel, ensuring that your notifications are delivered in the most effective way possible.

✨ Features

  • 🌈 Single API for all messaging providers (In-App, Email, SMS, Push, Chat)
  • πŸ’… Easily manage notifications 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 multi-channel messages in a single dashboard
  • πŸ“¦ Embeddable notification center with real-time updates
  • πŸ‘¨β€πŸ’» Community driven

πŸ“š Table Of Contents

πŸš€ Getting Started

We are excited to launch the complete Novu API and admin panel. Want to give it a test before the official release? Here is how:

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: 'john1@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 a real-time notification center to your web app without building it yourself. You can use our React / Vue / Angular component or an iframe embed.

notification-center-912bb96e009fb3a69bafec23bcde00b0

Read more about how to add a notification center to your app with the Novu API here

React Component Β· Vue Component Β· Angular Component

Providers

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

πŸ’Œ Email

πŸ“ž SMS

πŸ“± Push

πŸ‘‡ Chat

  • Slack
  • Discord
  • MS Teams
  • Mattermost

πŸ“± In-App

Other (Coming Soon...)

  • PagerDuty

πŸ“‹ Read Our Code Of Conduct

Before you begin coding and collaborating, please read our Code of Conduct thoroughly to understand the standards (that you are required to adhere to) for community engagement. As part of our open-source community, we hold ourselves and other contributors to a high standard of communication. As a participant and contributor to this project, you are agreeing to abide by our Code of Conduct.

πŸ’» Need Help?

We are more than happy to help you. If you are getting any errors or facing problems while working on this project, join our Discord server and ask for help. We are open to discussing anything related to the project.

⚑ Immediate working space with Gitpod

Open in Gitpod

πŸ”— Links

πŸ›‘οΈ License

Novu is licensed under the MIT License - see the LICENSE file for details.

πŸ’ͺ Thanks To All Contributors

Thanks a lot for spending your time helping Novu grow. Keep rocking πŸ₯‚