NodeJS SDK

Connect a Node.js application to Novu

Novu’s Node.js SDK provides simple, yet comprehensive notification management, and delivery capabilities through multiple channels that you can implement using code that integrates seamlessly with your Node.js application.

Explore the source code on GitHub

Installation

• NPM
• PNPM
• Yarn
• Bun

npm add @novu/api

npm add @novu/api

pnpm add @novu/api

yarn add @novu/api zod

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

bun add @novu/api

Usage

• US Region
• EU Region

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

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

async function run() {
  const result = await novu.trigger({
    to: {
      "subscriberId": "subscriber_unique_identifier",
      "firstName": "Albert",
      "lastName": "Einstein",
      "email": "[e-mail]",
      "phone": "[phone]",
    },
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {
      "email": {
        "bcc": "[e-mail]"
      },
    },
  });

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

run();

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

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

async function run() {
  const result = await novu.trigger({
    to: {
      "subscriberId": "subscriber_unique_identifier",
      "firstName": "Albert",
      "lastName": "Einstein",
      "email": "[e-mail]",
      "phone": "[phone]",
    },
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {
      "email": {
        "bcc": "[e-mail]"
      },
    },
  });

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

run();

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

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

async function run() {
  const result = await novu.trigger({
    to: {
      "subscriberId": "subscriber_unique_identifier",
      "firstName": "Albert",
      "lastName": "Einstein",
      "email": "[e-mail]",
      "phone": "[phone]",
    },
    workflowId: "workflow_identifier",
    payload: {
      "comment_id": "string",
      "post": {
        "text": "string",
      },
    },
    overrides: {
      "email": {
        "bcc": "[e-mail]"
      },
    },
  });

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

run();