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

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Pagination
• 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.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Trigger Notification Event

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

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.trigger({
    name: "workflow_identifier",
    to: [
      {
        topicKey: "<value>",
        type: "Topic",
      },
      {
        topicKey: "<value>",
        type: "Topic",
      },
    ],
  });

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

run();

Trigger Notification Events in Bulk

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

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.triggerBulk({
    events: [
      {
        name: "workflow_identifier",
        to: [
          {
            topicKey: "<value>",
            type: "Topic",
          },
          {
            subscriberId: "<id>",
          },
        ],
      },
      {
        name: "workflow_identifier",
        to: [
          "SUBSCRIBER_ID",
        ],
      },
      {
        name: "workflow_identifier",
        to: [
          {
            topicKey: "<value>",
            type: "Topic",
          },
          {
            topicKey: "<value>",
            type: "Topic",
          },
        ],
      },
    ],
  });

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

run();

Broadcast Event to All

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

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

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

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

run();

Cancel Triggered Event

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

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

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

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

run();

Available Resources and Operations

integrations

• list - Get integrations
• create - Create integration
• listActive - Get active integrations
• update - Update integration
• delete - Delete integration
• setAsPrimary - Set integration as primary

integrations.webhooks

• retrieve - Get webhook support status for provider

messages

• retrieve - Get messages
• delete - Delete message
• deleteByTransactionId - Delete messages by transactionId

notifications

• list - Get notifications
• retrieve - Get notification

notifications.stats

• retrieve - Get notification statistics
• graph - Get notification graph statistics

Novu SDK

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

subscribers

• list - Get subscribers
• create - Create subscriber
• retrieve - Get subscriber
• update - Update subscriber
• delete - Delete subscriber
• createBulk - Bulk create subscribers

subscribers.authentication

• chatAccessOauthCallBack - Handle providers oauth redirect
• chatAccessOauth - Handle chat oauth

subscribers.credentials

• update - Update subscriber credentials
• append - Modify subscriber credentials
• delete - Delete subscriber credentials by providerId

subscribers.messages

• markAllAs - Mark a subscriber messages as seen, read, unseen or unread
• markAll - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
• updateAsSeen - Mark message action as seen

subscribers.notifications

• feed - Get in-app notification feed for a particular subscriber
• unseenCount - Get the unseen in-app notifications count for subscribers feed

subscribers.preferences

• list - Get subscriber preferences
• updateGlobal - Update subscriber global preferences
• retrieveByLevel - Get subscriber preferences by level
• update - Update subscriber preference

subscribers.properties

• updateOnlineFlag - Update subscriber online status

topics

• create - Topic creation
• list - Get topic list filtered
• delete - Delete topic
• retrieve - Get topic
• rename - Rename a topic

topics.subscribers

• assign - Subscribers addition
• retrieve - Check topic subscriber
• remove - Subscribers removal

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.

• cancel - Cancel triggered event
• integrationsCreate - Create integration
• integrationsDelete - Delete integration
• integrationsList - Get integrations
• integrationsListActive - Get active integrations
• integrationsSetAsPrimary - Set integration as primary
• integrationsUpdate - Update integration
• integrationsWebhooksRetrieve - Get webhook support status for provider
• messagesDelete - Delete message
• messagesDeleteByTransactionId - Delete messages by transactionId
• messagesRetrieve - Get messages
• notificationsList - Get notifications
• notificationsRetrieve - Get notification
• notificationsStatsGraph - Get notification graph statistics
• notificationsStatsRetrieve - Get notification statistics
• subscribersAuthenticationChatAccessOauth - Handle chat oauth
• subscribersAuthenticationChatAccessOauthCallBack - Handle providers oauth redirect
• subscribersCreate - Create subscriber
• subscribersCreateBulk - Bulk create subscribers
• subscribersCredentialsAppend - Modify subscriber credentials
• subscribersCredentialsDelete - Delete subscriber credentials by providerId
• subscribersCredentialsUpdate - Update subscriber credentials
• subscribersDelete - Delete subscriber
• subscribersList - Get subscribers
• subscribersMessagesMarkAll - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
• subscribersMessagesMarkAllAs - Mark a subscriber messages as seen, read, unseen or unread
• subscribersMessagesUpdateAsSeen - Mark message action as seen
• subscribersNotificationsFeed - Get in-app notification feed for a particular subscriber
• subscribersNotificationsUnseenCount - Get the unseen in-app notifications count for subscribers feed
• subscribersPreferencesList - Get subscriber preferences
• subscribersPreferencesRetrieveByLevel - Get subscriber preferences by level
• subscribersPreferencesUpdate - Update subscriber preference
• subscribersPreferencesUpdateGlobal - Update subscriber global preferences
• subscribersPropertiesUpdateOnlineFlag - Update subscriber online status
• subscribersRetrieve - Get subscriber
• subscribersUpdate - Update subscriber
• topicsCreate - Topic creation
• topicsDelete - Delete topic
• topicsList - Get topic list filtered
• topicsRename - Rename a topic
• topicsRetrieve - Get topic
• topicsSubscribersAssign - Subscribers addition
• topicsSubscribersRemove - Subscribers removal
• topicsSubscribersRetrieve - Check topic subscriber
• trigger - Trigger event
• triggerBroadcast - Broadcast event to all
• triggerBulk - Bulk trigger event

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

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

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.list();

  for await (const page of result) {
    // Handle the page
    console.log(page);
  }
}

run();

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 | 400, 404, 409 | application/json | | errors.ValidationErrorDto | 422 | 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({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  let result;
  try {
    result = await novu.trigger({
      name: "workflow_identifier",
      to: [
        {
          topicKey: "<value>",
          type: "Topic",
        },
        {
          topicKey: "<value>",
          type: "Topic",
        },
      ],
    });

    // 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 ValidationErrorDto): {
        // Handle err.data$: ValidationErrorDtoData
        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 | | --- | ------------------------ | | 0 | https://api.novu.co | | 1 | https://eu.api.novu.co |

Example

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

const novu = new Novu({
  serverIdx: 1,
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.trigger({
    name: "workflow_identifier",
    to: [
      {
        topicKey: "<value>",
        type: "Topic",
      },
      {
        topicKey: "<value>",
        type: "Topic",
      },
    ],
  });

  // 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://api.novu.co",
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.trigger({
    name: "workflow_identifier",
    to: [
      {
        topicKey: "<value>",
        type: "Topic",
      },
      {
        topicKey: "<value>",
        type: "Topic",
      },
    ],
  });

  // 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 | | -------- | ------ | ------- | | apiKey | apiKey | API key |

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

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

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.trigger({
    name: "workflow_identifier",
    to: [
      {
        topicKey: "<value>",
        type: "Topic",
      },
      {
        topicKey: "<value>",
        type: "Topic",
      },
    ],
  });

  // 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({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.trigger({
    name: "workflow_identifier",
    to: [
      {
        topicKey: "<value>",
        type: "Topic",
      },
      {
        topicKey: "<value>",
        type: "Topic",
      },
    ],
  }, {
    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,
  },
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.trigger({
    name: "workflow_identifier",
    to: [
      {
        topicKey: "<value>",
        type: "Topic",
      },
      {
        topicKey: "<value>",
        type: "Topic",
      },
    ],
  });

  // 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!

SDK Created by Speakeasy