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
• Retries
• Error Handling
• Server Selection
• Custom HTTP Client
• Authentication
• Debugging

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

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("<value>");

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

run();

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",
    overrides: {},
    payload: {},
    to: [
      {
        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>",
    overrides: {},
    payload: {},
  });

  // 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: [],
  });

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

run();

Available Resources and Operations

changes

• apply - Apply change
• applyBulk - Apply changes
• count - Get changes count
• retrieve - Get changes

environments

• list - Get environments
• retrieve - Get current environment

environments.apiKeys

• list - Get api keys

executionDetails

• retrieve - Get execution details

feeds

• create - Create feed
• delete - Delete feed
• retrieve - Get feeds

integrations

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

integrations.webhooks

• retrieve - Get webhook support status for provider

layouts

• create - Layout creation
• delete - Delete layout
• list - Filter layouts
• retrieve - Get layout
• setAsDefault - Set default layout
• update - Update a layout

messages

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

notifications

• list - Get notifications
• retrieve - Get notification

notifications.stats

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

Novu SDK

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

organizations

• eeOrganizationControllerRenameOrganization - Rename organization name
• retrieve - Fetch current organization details
• update - Update organization branding details

subscribers

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

subscribers.authentication

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

subscribers.credentials

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

subscribers.messages

• 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.
• markAllAs - Mark a subscriber messages as seen, read, unseen or unread
• updateAsSeen - Mark message action as seen

subscribers.notifications

• retrieve - 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
• retrieveByLevel - Get subscriber preferences by level
• update - Update subscriber preference
• updateGlobal - Update subscriber global preferences

subscribers.properties

• updateOnlineFlag - Update subscriber online status

tenants

• create - Create tenant
• delete - Delete tenant
• list - Get tenants
• retrieve - Get tenant
• update - Update tenant

topics

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

topics.subscribers

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

workflowGroups

• create - Create workflow group
• delete - Delete workflow group
• list - Get workflow groups
• retrieve - Get workflow group
• update - Update workflow group

workflows

• create - Create workflow
• delete - Delete workflow
• list - Get workflows
• retrieve - Get workflow
• update - Update workflow

workflows.status

• update - Update workflow status

workflows.variables

• retrieve - Get available variables

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
• changesApplyBulk
• changesApply
• changesCount
• changesRetrieve
• environmentsApiKeysList
• environmentsList
• environmentsRetrieve
• executionDetailsRetrieve
• feedsCreate
• feedsDelete
• feedsRetrieve
• integrationsCreate
• integrationsDelete
• integrationsListActive
• integrationsList
• integrationsSetAsPrimary
• integrationsUpdate
• integrationsWebhooksRetrieve
• layoutsCreate
• layoutsDelete
• layoutsList
• layoutsRetrieve
• layoutsSetAsDefault
• layoutsUpdate
• messagesDeleteByTransactionId
• messagesDelete
• messagesRetrieve
• notificationsList
• notificationsRetrieve
• notificationsStatsGraph
• notificationsStatsRetrieve
• organizationsEEOrganizationControllerRenameOrganization
• organizationsRetrieve
• organizationsUpdate
• subscribersAuthenticationChatAccessOauthCallBack
• subscribersAuthenticationChatAccessOauth
• subscribersCreateBulk
• subscribersCreate
• subscribersCredentialsAppend
• subscribersCredentialsDelete
• subscribersCredentialsUpdate
• subscribersDelete
• subscribersList
• subscribersMessagesMarkAllAs
• subscribersMessagesMarkAll
• subscribersMessagesUpdateAsSeen
• subscribersNotificationsRetrieve
• subscribersNotificationsUnseenCount
• subscribersPreferencesList
• subscribersPreferencesRetrieveByLevel
• subscribersPreferencesUpdateGlobal
• subscribersPreferencesUpdate
• subscribersPropertiesUpdateOnlineFlag
• subscribersRetrieve
• subscribersUpdate
• tenantsCreate
• tenantsDelete
• tenantsList
• tenantsRetrieve
• tenantsUpdate
• topicsCreate
• topicsDelete
• topicsList
• topicsRename
• topicsRetrieve
• topicsSubscribersAssign
• topicsSubscribersDelete
• topicsSubscribersRetrieve
• triggerBroadcast
• triggerBulk
• trigger
• workflowGroupsCreate
• workflowGroupsDelete
• workflowGroupsList
• workflowGroupsRetrieve
• workflowGroupsUpdate
• workflowsCreate
• workflowsDelete
• workflowsList
• workflowsRetrieve
• workflowsStatusUpdate
• workflowsUpdate
• workflowsVariablesRetrieve

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

All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

| Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | / |

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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.

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

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

async function run() {
  let result;
  try {
    result = await novu.cancel("<value>");

    // Handle the result
    console.log(result);
  } catch (err) {
    switch (true) {
      case (err instanceof SDKValidationError): {
        // Validation errors can be pretty-printed
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx 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 | Variables | | - | ------ | --------- | | 0 | https://api.novu.co | None | | 1 | https://eu.api.novu.co | None |

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

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

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

  // 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 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.cancel("<value>");

  // 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.cancel("<value>");

  // 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.cancel("<value>", {
    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.cancel("<value>");

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