README.md

The open-source notification infrastructure for developers

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

🎉 Novu is live on Product Hunt! 🎉

We are on Product Hunt and would appreciate any help you can give us 🩷
BONUS: watch our video, answer the riddle, and win awesome swag!

🎉 We're participating in Hacktoberfest 2023! 🎉

Interested in participating in Hacktoberfest? We extend a warm invitation! You also get the opportunity to win some swag 😁

⭐️ If you're new to Hacktoberfest, you can learn more and register to participate here. Registration is from September 26th - October 31st.

• Our Hacktoberfest kickoff event is happening on October 2, 2023. 🚀
• Check out our website for hacktoberfest instructions.
• Join our Discord and engage with our community, get answers to your challenges, stay updated on events, announcements & prizes.

In addition to this repository, here are the other Novu repositories you can contribute to for Hacktoberfest:

• Novu Docs
• Novu PHP SDK
• Novu Ruby SDK
• Novu Python SDK
• Novu Go SDK
• Novu Java SDK
• Novu Kotlin SDK
• Novu Elixir SDK
• Novu Rust SDK

Your contribution, no matter its size, holds immense value. We eagerly await to see the impact you'll make in our community! 🚀

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 · Java

⭐️ 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
• Embeddable notification center
• Providers
  • Email
  • SMS
  • Push
  • Chat
  • In-App
  • Others
• Need Help?
• Links
• License

🚀 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.

For API documentation and reference, please visit Novu API Reference.

To get started with the Node.js package, you can install it using npm:

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.

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

• Sendgrid
• Netcore
• Mailgun
• SES
• Postmark
• Custom SMTP
• Mailjet
• Mandrill
• SendinBlue
• MailerSend
• Infobip
• Resend
• SparkPost
• Outlook 365

📞 SMS

• Twilio
• Plivo
• SNS
• Nexmo - Vonage
• Sms77
• Telnyx
• Termii
• Gupshup
• SMS Central
• Maqsam
• 46elks
• Clickatell
• Burst SMS
• Firetext
• Infobip
• Bandwidth
• RingCentral

📱 Push

• FCM
• Expo
• APNS
• OneSignal
• Pushwoosh

👇 Chat

• Slack
• Discord
• MS Teams
• Mattermost

📱 In-App

• Novu
• MagicBell

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 discuss anything related to the project.

⚡ Immediate working space with Gitpod

🔗 Links

• Home page
• Contribution Guidelines
• Run Novu Locally

🛡️ 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 🥂