The <Inbox /> infrastructure for modern products

The notification platform that turns complex multi-channel delivery into a single component. Built for developers, designed for growth, powered by open source.

Summary

Novu API: Novu REST API. Please see https://docs.novu.co/api-reference for more details.

For more information about the API: Novu Documentation

SDK Installation
Requirements
SDK Example Usage
Available Resources and Operations
Standalone functions
Error Handling
Server Selection
Custom HTTP Client
Authentication
Retries
Debugging
Development
- Maturity
- Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @novu/api

PNPM

pnpm add @novu/api

Bun

bun add @novu/api

Yarn

yarn add @novu/api zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Claude installation steps

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Novu": {
      "command": "npx",
      "args": [
        "-y", "--package", "@novu/api",
        "--",
        "mcp", "start",
        "--secret-key", "..."
      ]
    }
  }
}

Cursor installation steps

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Novu": {
      "command": "npx",
      "args": [
        "-y", "--package", "@novu/api",
        "--",
        "mcp", "start",
        "--secret-key", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @novu/api -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Trigger Notification Event

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.trigger({
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {},
    to: "SUBSCRIBER_ID",
  });

  // Handle the result
  console.log(result);
}

run();

Cancel Triggered Event

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.cancel("<id>");

  // Handle the result
  console.log(result);
}

run();

Broadcast Event to All

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.triggerBroadcast({
    name: "<value>",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {
      additionalProperties: {
        "fcm": {
          "data": {
            "key": "value",
          },
        },
      },
    },
  });

  // Handle the result
  console.log(result);
}

run();

Trigger Notification Events in Bulk

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.triggerBulk({
    events: [
      {
        workflowId: "workflow_identifier",
        payload: {
          "comment_id": "string",
          "post": {
            "text": "string",
          },
        },
        overrides: {},
        to: "SUBSCRIBER_ID",
      },
      {
        workflowId: "workflow_identifier",
        payload: {
          "comment_id": "string",
          "post": {
            "text": "string",
          },
        },
        overrides: {},
        to: "SUBSCRIBER_ID",
      },
      {
        workflowId: "workflow_identifier",
        payload: {
          "comment_id": "string",
          "post": {
            "text": "string",
          },
        },
        overrides: {},
        to: "SUBSCRIBER_ID",
      },
    ],
  });

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

Available methods

integrations

list - List all integrations
create - Create an integration
update - Update an integration
delete - Delete an integration
setAsPrimary - Update integration as primary
listActive - List active integrations

messages

retrieve - List all messages
delete - Delete a message
deleteByTransactionId - Delete messages by transactionId

notifications

list - List all events
retrieve - Retrieve an event

Novu SDK

trigger - Trigger event
cancel - Cancel triggered event
triggerBroadcast - Broadcast event to all
triggerBulk - Bulk trigger event

subscribers

search - Search subscribers
create - Create a subscriber
retrieve - Retrieve a subscriber
patch - Update a subscriber
delete - Delete subscriber
createBulk - Bulk create subscribers

subscribers.credentials

update - Update provider credentials
append - Upsert provider credentials
delete - Delete provider credentials

subscribers.messages

updateAsSeen - Update notification action status
markAll - Update all notifications state
markAllAs - Update notifications state

subscribers.notifications

feed - Retrieve subscriber notifications
unseenCount - Retrieve unseen notifications count

subscribers.preferences

list - Retrieve subscriber preferences
update - Update subscriber preferences

subscribers.properties

updateOnlineFlag - Update subscriber online status

subscribers.topics

list - Retrieve subscriber subscriptions

topics

list - List all topics
create - Create a topic
get - Retrieve a topic
update - Update a topic
delete - Delete a topic

topics.subscriptions

list - List topic subscriptions
create - Create topic subscriptions
delete - Delete topic subscriptions

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

cancel - Cancel triggered event
integrationsCreate - Create an integration
integrationsDelete - Delete an integration
integrationsList - List all integrations
integrationsListActive - List active integrations
integrationsSetAsPrimary - Update integration as primary
integrationsUpdate - Update an integration
messagesDelete - Delete a message
messagesDeleteByTransactionId - Delete messages by transactionId
messagesRetrieve - List all messages
notificationsList - List all events
notificationsRetrieve - Retrieve an event
subscribersCreate - Create a subscriber
subscribersCreateBulk - Bulk create subscribers
subscribersCredentialsAppend - Upsert provider credentials
subscribersCredentialsDelete - Delete provider credentials
subscribersCredentialsUpdate - Update provider credentials
subscribersDelete - Delete subscriber
subscribersMessagesMarkAll - Update all notifications state
subscribersMessagesMarkAllAs - Update notifications state
subscribersMessagesUpdateAsSeen - Update notification action status
subscribersNotificationsFeed - Retrieve subscriber notifications
subscribersNotificationsUnseenCount - Retrieve unseen notifications count
subscribersPatch - Update a subscriber
subscribersPreferencesList - Retrieve subscriber preferences
subscribersPreferencesUpdate - Update subscriber preferences
subscribersPropertiesUpdateOnlineFlag - Update subscriber online status
subscribersRetrieve - Retrieve a subscriber
subscribersSearch - Search subscribers
subscribersTopicsList - Retrieve subscriber subscriptions
topicsCreate - Create a topic
topicsDelete - Delete a topic
topicsGet - Retrieve a topic
topicsList - List all topics
topicsSubscribersRetrieve - Check topic subscriber
topicsSubscriptionsCreate - Create topic subscriptions
topicsSubscriptionsDelete - Delete topic subscriptions
topicsSubscriptionsList - List topic subscriptions
topicsUpdate - Update a topic
trigger - Trigger event
triggerBroadcast - Broadcast event to all
triggerBulk - Bulk trigger event

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the trigger method may throw the following errors:

Error Type	Status Code	Content Type
errors.ErrorDto	414	application/json
errors.ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
errors.ValidationErrorDto	422	application/json
errors.ErrorDto	500	application/json
errors.SDKError	4XX, 5XX	/

If the method throws an error and it is not captured by the known errors, it will default to throwing a SDKError.

import { Novu } from "@novu/api";
import {
  ErrorDto,
  SDKValidationError,
  ValidationErrorDto,
} from "@novu/api/models/errors";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  let result;
  try {
    result = await novu.trigger({
      workflowId: "workflow_identifier",
      payload: {
        "comment_id": "string",
        "post": {
          "text": "string",
        },
      },
      overrides: {},
      to: "SUBSCRIBER_ID",
    });

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof ErrorDto): {
        // Handle err.data$: ErrorDtoData
        console.error(err);
        return;
      }
      case (err instanceof ErrorDto): {
        // Handle err.data$: ErrorDtoData
        console.error(err);
        return;
      }
      case (err instanceof ValidationErrorDto): {
        // Handle err.data$: ValidationErrorDtoData
        console.error(err);
        return;
      }
      case (err instanceof ErrorDto): {
        // Handle err.data$: ErrorDtoData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Description
0	`https://api.novu.co`
1	`https://eu.api.novu.co`

Example

import { Novu } from "@novu/api";

const novu = new Novu({
  serverIdx: 1,
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.trigger({
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {},
    to: "SUBSCRIBER_ID",
  });

  // Handle the result
  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Novu } from "@novu/api";

const novu = new Novu({
  serverURL: "https://eu.api.novu.co",
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.trigger({
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {},
    to: "SUBSCRIBER_ID",
  });

  // Handle the result
  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Novu } from "@novu/api";
import { HTTPClient } from "@novu/api/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Novu({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
`secretKey`	apiKey	API key

To authenticate with the API the secretKey parameter must be set when initializing the SDK client instance. For example:

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.trigger({
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {},
    to: "SUBSCRIBER_ID",
  });

  // Handle the result
  console.log(result);
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.trigger({
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {},
    to: "SUBSCRIBER_ID",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  // Handle the result
  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Novu } from "@novu/api";

const novu = new Novu({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  secretKey: "YOUR_SECRET_KEY_HERE",
});

async function run() {
  const result = await novu.trigger({
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {},
    to: "SUBSCRIBER_ID",
  });

  // Handle the result
  console.log(result);
}

run();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Novu } from "@novu/api";

const sdk = new Novu({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

@novu/api

The <Inbox /> infrastructure for modern products

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Model Context Protocol (MCP) Server

Requirements

SDK Example Usage

Trigger Notification Event

Cancel Triggered Event

Broadcast Event to All

Trigger Notification Events in Bulk

Available Resources and Operations

Standalone functions

Error Handling

Server Selection

Select Server by Index

Example

Override Server URL Per-Client

Custom HTTP Client

Authentication

Per-Client Security Schemes

Retries

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

Readme

Keywords

Package Sidebar

Install

Repository

Homepage

DownloadsWeekly Downloads

Version

License

Unpacked Size

Total Files

Last publish

Collaborators

Weekly Downloads