(function (w, d, s, l, i) {
  w[l] = w[l] || [];
  w[l].push({ "gtm.start": new Date().getTime(), event: "gtm.js" });
  var f = d.getElementsByTagName(s)[0],
    j = d.createElement(s),
    dl = l != "dataLayer" ? "&l=" + l : "";
  j.async = true;
  j.src = "https://www.googletagmanager.com/gtm.js?id=" + i + dl;
  f.parentNode.insertBefore(j, f);
})(window, document, "script", "dataLayer", "GTM-KXMC4XP2");


_linkedin_partner_id = "5915650";
window._linkedin_data_partner_ids = window._linkedin_data_partner_ids || [];
window._linkedin_data_partner_ids.push(_linkedin_partner_id);


Authorization

Novu

<Inbox />

Integrations

API Reference

SDKs

Recipes

Community

Get Started

Pricing

Blog

Contact us

v0.x

workflow group was previously named notification group

Get workflow group

api key

Novu is a full-stack (UI Components, API, and Framework) open source notification infrastructure platform for building, managing, delivering, and monitoring all types of end-user notifications.

What is Novu

How Novu Works

Change notification messaging, verbiage, and cadence without requiring engineering's help by using the Novu Dashboard UI.

For Non-Developers

No-Code tools to manage your notifications

Start building with Novu by following our Quick Start guides. These guides provide step-by-step instructions for integrating Novu into your application.

Overview

Quickstart

Next.js

How to send notifications with Next.js and Novu Framework

Express.js

How to send notifications with Express.js and Novu Framework

Remix

How to send notifications with Remix and Novu Framework

NestJS

How to send notifications with NestJS and Novu Framework

Svelte

How to send notifications with Svelte and Novu Framework

Nuxt

How to send notifications with Nuxt and Novu Framework

How to send notifications with H3 and Novu Framework

AWS Lambda

How to send notifications with AWS Lambda and Novu Framework

Workflows are at the core of responding to events in your system with notifications. Novu Framework enables you to declare type-safe, validated, and version-controlled Workflows with code.

Workflows

Controls

Managing Trigger Events from Request to Processing

Trigger

Subscribers

Bridge Endpoint

Environments

Preferences

Topics

Learn about how to implement multi-tenant notifications in Novu

Multi-tenancy

Introduction to Novu

Novu Architecture Diagram

Building notification workflows with the Novu Framework

Local Studio

Learn how to manage your notification workflow and allow no-code users to modify it.

Manage Content

Manage notification workflow content

Digest Engine

Collect multiple events to a single message with the Digest Engine

Delay

Delay Action Step

Used to execute any custom code as a step in the workflow.

Custom Step

Custom Action Step

Learn how to add novu powered In-App Inbox to your React app

React Get Started

Learn how to style the pre built Inbox component

Styling

Styling the Inbox component

<Bell />

<Notifications />

<Preferences />

<InboxContent />

Create Custom Inbox UI with React Hooks

NovuProvider

useNotifications

usePreferences

useCounts

useNovu

Tabs

Configuring Multiple Tabs

Learn how to localize the pre built Inbox component

Localization

Localizing the Inbox component

Learn how to prepare your inbox before going to production

Going to production

This guide outlines the key differences between the `@novu/notification-center` package and the new `@novu/react` package. Follow the steps below to migrate your application to the latest version.

Migration Guide

A lightweight, standalone package for building custom in-app notification interfaces with Novu, providing essential functionalities and flexibility.

Headless Inbox

Headless Inbox API Reference

Learn how to add Novu powered Inbox to your React Native app

React Native Get Started

Syncing your local changes to the Novu Cloud Dashboard

Going to Production

GitHub Actions

Get started and get involved with the Novu Project

Community Overview

Understand the difference between Novu Project and Novu Cloud

Novu Project and Novu Cloud

Introduction

Deploy with Docker

Telemetry

The set of rules and guidelines that govern interaction among community members

Code of Conduct

Novu Community Code of conduct

Your guide for engaging with the Novu Community

Get Involved

Get involved with the Novu Community

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

MacOS/Linux

Learn how to configure your local Windows machine to run Novu

Windows

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

Learn how to enable/disable specific features in Novu

Feature Flags

Monorepo Structure

Add a New Provider

Add a new provider

Client

Workflow

Workflow Interface

Step Interface

Email

Email Channel Step

In-App

In-App Channel Step

SMS Channel Step

Push

Push Channel Step

Chat

Chat Channel Step

Digest

Digest Action Step

Custom

NodeJS SDK

PHP SDK

Laravel SDK

Python SDK

Kotlin SDK

Java SDK

Ruby SDK

Go SDK

C#/.NET

Novu supports advanced user authentication capabilities like OAuth, SSO, MFA and more, providing enterprise customers with a robust, secure, and user-friendly authentication solution.

Authentication

Learn how to enable Single Sign-On (SSO) for your account.

SAML SSO

Single Sign-On (SSO) for your account

Manage your billing and payment information, view invoices, and upgrade your subscription plan.

Billing

Billing and Payments

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

Security and Compliance

Retry API requests fearlessly, ensuring the operation performs just once!

Idempotent Requests

Learn how to update your database data through migrations.

Data Migrations

Glossary

In this page you can learn about how to work with Novu's API

API Overview

In this page you can learn about how rate limiting works with Novu's API

API Rate Limiting


    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.
    

Bulk create subscribers

Get subscriber by your internal id used to identify the subscriber

Get subscriber

Used to update the subscriber entity with new information

Update subscriber

Deletes a subscriber entity from the Novu platform

Delete subscriber

Subscriber credentials associated to the delivery methods such as slack and push tokens.

API Reference

Get workflow group

Authorizations

Path Parameters

Response