The <Inbox /> infrastructure for modern products

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

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

$3

``bash
npm add @novu/api
`

$3

`bash
pnpm add @novu/api
`

$3

`bash
bun add @novu/api
`

$3

`bash
yarn add @novu/api
`


Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.


SDK Example Usage

$3

`typescript
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",
actor: "",
context: {
"key": "org-acme",
},
});

console.log(result);
}

run();

`

$3

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

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

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

console.log(result);
}

run();

`

$3

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

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

async function run() {
const result = await novu.triggerBroadcast({
name: "",
payload: {
"comment_id": "string",
"post": {
"text": "string",
},
},
overrides: {
additionalProperties: {
"fcm": {
"data": {
"key": "value",
},
},
},
},
actor: {
firstName: "John",
lastName: "Doe",
email: "john.doe@example.com",
phone: "+1234567890",
avatar: "https://example.com/avatar.jpg",
locale: "en-US",
timezone: "America/New_York",
subscriberId: "",
},
context: {
"key": "org-acme",
},
});

console.log(result);
}

run();

`

$3

`typescript
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",
},
],
});

console.log(result);
}

run();

`


Available Resources and Operations

NovuError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description |
| ------------------- | ---------- | --------------------------------------------------------------------------------------- |
| error.message | string | Error message |
| error.statusCode | number | HTTP response status code eg 404 |
| error.headers | Headers | HTTP response headers |
| error.body | string | HTTP body. Can be empty string if no body is returned. |
| error.rawResponse | Response | Raw HTTP response |
| error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

$3

`

$3

\* Check the method documentation to see if the error is applicable.


Server Selection

$3

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

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

const novu = new Novu({
serverIdx: 0,
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",
actor: "",
context: {
"key": "org-acme",
},
});

console.log(result);
}

run();

`

$3

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:
`typescript
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",
actor: "",
context: {
"key": "org-acme",
},
});

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:

`typescript
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: httpClient });
`


Authentication

$3

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:
`typescript
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",
actor: "",
context: {
"key": "org-acme",
},
});

console.log(result);
}

run();

`


File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

> [!TIP]
>
> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
>
> - Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
> - Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
> - Browsers: All supported browsers return an instance to a File when reading the value from an element.
> - Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

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

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

async function run() {
const result = await novu.translations.upload({
resourceId: "welcome-email",
resourceType: "workflow",
files: [],
});

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:
`typescript
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",
actor: "",
context: {
"key": "org-acme",
},
}, {
retries: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
});

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:
`typescript
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",
actor: "",
context: {
"key": "org-acme",
},
});

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.

`typescript
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!

$3