You can interface with Novu's API either over REST, or via libraries for certain languages. Below is a list of our official, supported libraries.

Overview

Novu

API Reference

Learn by Videos

Get instant help

FAQs

Authorization

SDKs

Cookbook

Guides

Demos

Community & Support

Use Cases

Get API Key

Novu is an open-source notification infrastructure, built for engineering teams to help them build rich product notification experiences.

Start Point

How Novu Works?

Concepts

Sign Up on Novu Cloud

Learn how to send your first notification via the Novu Cloud dashboard.

Send Your First Notification

Learn how to use Novu to quickly send multi-channel (SMS, Email, Chat, Push) notifications with any language/framework of your choice.

Learn how to use Novu to quickly send multi-channel (SMS, Email, Chat, Push) notifications.

General

Subscribers

Topics

Preferences

Workflows

Learn how to customize your notifications flow in Novu.

Step Filters

Digest Engine

Delay Action

Template Store

Messages

Learn how to process incoming emails for a domain or subdomain

Inbound Parse Webhook

Activity Feed

Tenants

Environments

Learn more about Novu's Notification Center.

Introduction

Vue Component

Angular

Angular Component

Web Component

Iframe

Iframe Embed

Backend SDK methods

The key features of Novu’s notification editor and how to use them

Handlebars & Helpers

Brand

Explore how to create notification content

Content Creation

Explore how to create and manage layouts in Novu

Layouts

Learn about what channels, providers and oganizations are

Integration Store

Learn about the default Novu email and sms providers

Novu Providers

Learn how to integrate in-app notificaton center and send in-app notification using Novu

Learn the process of configuring email overrides & attachments with Novu

Learn how to use the Infobip provider to send email notifications using Novu

Infobip

Learn how to use the Amazon SES provider to send email notifications using Novu

Amazon SES

Learn how to use the MailerSend provider to send email notifications using Novu

Mailersend

Learn how to use the Mailgun provider to send email notifications using Novu

Mailgun

Learn how to use the Mailjet provider to send email notifications using Novu

Mailjet

Learn how to use the Mandrill provider to send email notifications using Novu

Mandrill

Learn how to use the Netcore provider to send email notifications using Novu

Netcore

Learn how to use the Outlook 365 provider to send email notifications using Novu

Outlook 365

Learn how to use the Postmark provider to send email notifications using Novu

Postmark

Learn how to use the Resend provider to send email notifications using Novu

Resend

Learn how to use the Sendgrid provider to send email notifications using Novu

SendGrid

Learn how to use the Sendinblue provider to send email notifications using Novu

Sendinblue

Learn how to use the Sparkpost provider to send email notifications using Novu

Sparkpost

Learn how to use the Plunk provider to send email notifications using Novu

Plunk

Learn how to use the Custom SMTP provider to send email notifications using Novu

Custom SMTP

Learn how to use the Twilio provider to send sms notifications using Novu

Twilio

Learn how to use the SMS77 provider to send sms notifications using Novu

SMS77

Learn how to use the Africa's Talking provider to send sms notifications using Novu

Africa's Talking

Learn how to use the Infobip provider to send sms notifications using Novu

Learn how to use the Sendchamp provider to send sms notifications using Novu

Sendchamp

Learn how to use the AWS SNS provider to send sms notifications using Novu

AWS SNS

Learn how to use the Nexmo provider to send sms notifications using Novu

Nexmo

Learn how to use the Plivo provider to send sms notifications using Novu

Plivo

Learn how to use the Telnyx provider to send sms notifications using Novu

Telnyx

Learn how to use the Termii provider to send sms notifications using Novu

Termii

Learn how to use the firetext provider to send sms notifications using Novu

firetext

Learn how to use the gupshup provider to send sms notifications using Novu

gupshup

Learn how to use the Clickatell provider to send sms notifications using Novu

Clickatell

Learn how to send push notifications with Novu using external providers like FCM, Expo etc.

Push Channel Introduction

Learn how to use the Firebase Cloud Messaging (FCM) provider to send push notifications using Novu

Firebase Cloud Messaging (FCM)

Learn how to use the Apple Push Notification Service (APNS) provider to send push notifications using Novu

APNS

Apple Push Notification Service (APNS)

Learn how to use the Expo push provider to send push notifications using Novu

Expo Push

Learn how to use the Onesignal provider to send push notifications using Novu

Onesignal

Learn how to use the Push Webhook provider to send  notifications using Novu

Push Webhook

Learn about how to use Discord provider for chat notifications

Discord

Learn about how to use Slack provider for chat notifications

Slack

Learn about how to use MS Teams provider for chat notifications

MS Teams

Deploy with Docker

Leverage the digest functionality to send in-app notifications

How to Add Digest to In-App Notifications

Leverage the digest functionality to send email notifications

How to Add Digest to Email Notifications

Use the headless version of the notification center

How to use Headless Notification Center

Common questions related to security, compliance, privacy policy and terms and conditions

Security

Security and Compliance

See the most recent changes and learn about how to shape Novu's future

Changelog

Roadmap

Learn how to configure your local machine to run Novu

Machine setup

Prerequisites and steps to run Novu in local machine. Learn how to set up Novu on your local environment for testing and development.

Run Novu in local machine

Monorepo structure

Add a new provider

Novu’s Vue library provides a Vue component wrapper over the Notification Center Web that you can use to integrate the notification center into your Vue application. 

Novu’s React library provides a fully functional and embeddable notification center component with real-time updates that you can drop into your React application.

React Component

Novu’s Angular library provides an Angular component wrapper over the Notification Center Web that you can use to integrate the notification center into your Angular application. 

Novu’s Web Component library provides a fully functional and embeddable notification center widget with real-time updates that you can drop into any web application.

Embed a real-time notification center inside an iframe using our embedded script.

Novu’s headless library provides users with a lightweight, completely unstyled, zero UI solution for integrating notification functionality into their web applications.

Headless JavaScript Service

Node.js

Laravel

Python

Kotlin

Java

Ruby

C#/.NET

Recipes

Experience the power of Novu for triggering, digesting, and receiving notifications via different channels

Learn to manage many delivery providers across different channels in one dashboard

Managing multiple delivery providers in one place

A real-time fully functional embedded notification center

Fully featured embedded notification center

Learn to leverage Novu in digesting multiple events.

Digest multiple events in a single notification

Learn to send notifications in different languages effortlessly

Manage notifications in multiple languages

Novu can handle notifications at extremely large scale

Processing and sending notifications at any scale

Understand the lifecycle of your notifications

Debug notifications across channels in a single place

Learn to use Novu to centralize legacy notification implementations.

Centralized multiple legacy implementations of different teams

Frequently Asked Questions

Glossary


    Trigger event is the main (and only) way to send notifications to subscribers. 
    The trigger identifier is used to match the particular workflow associated with it. 
    Additional information can be passed according the body interface below.
    

Trigger event


      Using this endpoint you can trigger multiple events at once, to avoid multiple calls to the API.
      The bulk API is limited to 100 events per request.
    

Bulk trigger event

Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
      In the future could be used to trigger events to a subset of subscribers based on defined filters.

Broadcast event to all


    Using a previously generated transactionId during the event trigger,
     will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
    

Cancel triggered event

Returns a list of subscribers, could paginated using the `page` and `limit` query parameter

Get subscribers

Creates a subscriber entity, in the Novu platform. The subscriber will be later used to receive notifications, and access notification feeds. Communication credentials such as email, phone number, and 3 rd party credentials i.e slack tokens could be later associated to this entity.

Create subscriber


      Using this endpoint you can create multiple subscribers at once, to avoid multiple calls to the API.
      The bulk API is limited to 500 subscribers per request.
    

SDKs & Client Libraries

Overview

Client Side

React

Vue

Angular

Web Component

IFrame Embed

Headless JavaScript

Server Side

Node.js

Go

PHP

Laravel

.NET

Ruby

Java

Kotlin

Python

SDKs & Client Libraries

​Client Side

React

Vue

Angular

Web Component

IFrame Embed

Headless JavaScript

​Server Side

Node.js

Go

PHP

Laravel

.NET

Ruby

Java

Kotlin

Python

Client Side

Server Side