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](https://docs.novu.co)
## Table of Contents
* [SDK Installation](#sdk-installation)
* [Requirements](#requirements)
* [SDK Example Usage](#sdk-example-usage)
* [Available Resources and Operations](#available-resources-and-operations)
* [Standalone functions](#standalone-functions)
* [Error Handling](#error-handling)
* [Server Selection](#server-selection)
* [Custom HTTP Client](#custom-http-client)
* [Authentication](#authentication)
* [File uploads](#file-uploads)
* [Retries](#retries)
* [Debugging](#debugging)
* [Development](#development)
* [Maturity](#maturity)
* [Contributions](#contributions)
## SDK Installation
The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
### NPM
```bash
npm add @novu/api
```
### PNPM
```bash
pnpm add @novu/api
```
### Bun
```bash
bun add @novu/api
```
### Yarn
```bash
yarn add @novu/api
```
## Requirements
For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
## SDK Example Usage
### Trigger Notification Event
```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();
```
### Cancel Triggered Event
```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();
```
### Broadcast Event to All
```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();
```
### Trigger Notification Events in Bulk
```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
Available methods
### [Novu SDK](docs/sdks/novu/README.md)
* [trigger](docs/sdks/novu/README.md#trigger) - Trigger event
* [cancel](docs/sdks/novu/README.md#cancel) - Cancel triggered event
* [triggerBroadcast](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
* [triggerBulk](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
### [Activity](docs/sdks/activity/README.md)
* [track](docs/sdks/activity/README.md#track) - Track provider activity and engagement events
### [ChannelConnections](docs/sdks/channelconnections/README.md)
* [list](docs/sdks/channelconnections/README.md#list) - List all channel connections
* [create](docs/sdks/channelconnections/README.md#create) - Create a channel connection
* [retrieve](docs/sdks/channelconnections/README.md#retrieve) - Retrieve a channel connection
* [update](docs/sdks/channelconnections/README.md#update) - Update a channel connection
* [delete](docs/sdks/channelconnections/README.md#delete) - Delete a channel connection
### [ChannelEndpoints](docs/sdks/channelendpoints/README.md)
* [list](docs/sdks/channelendpoints/README.md#list) - List all channel endpoints
* [create](docs/sdks/channelendpoints/README.md#create) - Create a channel endpoint
* [retrieve](docs/sdks/channelendpoints/README.md#retrieve) - Retrieve a channel endpoint
* [update](docs/sdks/channelendpoints/README.md#update) - Update a channel endpoint
* [delete](docs/sdks/channelendpoints/README.md#delete) - Delete a channel endpoint
### [Contexts](docs/sdks/contexts/README.md)
* [create](docs/sdks/contexts/README.md#create) - Create a context
* [list](docs/sdks/contexts/README.md#list) - List all contexts
* [update](docs/sdks/contexts/README.md#update) - Update a context
* [retrieve](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
* [delete](docs/sdks/contexts/README.md#delete) - Delete a context
### [Domains](docs/sdks/domains/README.md)
* [list](docs/sdks/domains/README.md#list) - List domains for an environment
* [create](docs/sdks/domains/README.md#create) - Create a domain
* [retrieve](docs/sdks/domains/README.md#retrieve) - Retrieve a domain by name
* [update](docs/sdks/domains/README.md#update) - Update a domain
* [delete](docs/sdks/domains/README.md#delete) - Delete a domain
* [diagnose](docs/sdks/domains/README.md#diagnose) - Diagnose inbound DNS for a domain
* [verify](docs/sdks/domains/README.md#verify) - Verify a domain
#### [Domains.AutoConfigure](docs/sdks/autoconfigure/README.md)
* [retrieve](docs/sdks/autoconfigure/README.md#retrieve) - Retrieve auto-configuration availability
* [start](docs/sdks/autoconfigure/README.md#start) - Start DNS auto-configuration
#### [Domains.Routes](docs/sdks/routes/README.md)
* [list](docs/sdks/routes/README.md#list) - List routes for a domain
* [create](docs/sdks/routes/README.md#create) - Create a route
* [retrieve](docs/sdks/routes/README.md#retrieve) - Retrieve a route by address
* [update](docs/sdks/routes/README.md#update) - Update a route
* [delete](docs/sdks/routes/README.md#delete) - Delete a route
* [test](docs/sdks/routes/README.md#test) - Test an inbound route
### [EnvironmentVariables](docs/sdks/environmentvariables/README.md)
* [list](docs/sdks/environmentvariables/README.md#list) - List all variables
* [create](docs/sdks/environmentvariables/README.md#create) - Create a variable
* [retrieve](docs/sdks/environmentvariables/README.md#retrieve) - Get environment variable
* [update](docs/sdks/environmentvariables/README.md#update) - Update a variable
* [delete](docs/sdks/environmentvariables/README.md#delete) - Delete environment variable
* [usage](docs/sdks/environmentvariables/README.md#usage) - Retrieve a variable usage
### [Environments](docs/sdks/environments/README.md)
* [getTags](docs/sdks/environments/README.md#gettags) - List environment tags
* [diff](docs/sdks/environments/README.md#diff) - Compare resources between environments
* [publish](docs/sdks/environments/README.md#publish) - Publish resources to target environment
* [create](docs/sdks/environments/README.md#create) - Create an environment
* [list](docs/sdks/environments/README.md#list) - List all environments
* [update](docs/sdks/environments/README.md#update) - Update an environment
* [delete](docs/sdks/environments/README.md#delete) - Delete an environment
### [Integrations](docs/sdks/integrations/README.md)
* [list](docs/sdks/integrations/README.md#list) - List all integrations
* [create](docs/sdks/integrations/README.md#create) - Create an integration
* [update](docs/sdks/integrations/README.md#update) - Update an integration
* [delete](docs/sdks/integrations/README.md#delete) - Delete an integration
* [integrationsControllerAutoConfigureIntegration](docs/sdks/integrations/README.md#integrationscontrollerautoconfigureintegration) - Auto-configure an integration for inbound webhooks
* [setAsPrimary](docs/sdks/integrations/README.md#setasprimary) - Update integration as primary
* [listActive](docs/sdks/integrations/README.md#listactive) - List active integrations
* [generateConnectOAuthUrl](docs/sdks/integrations/README.md#generateconnectoauthurl) - Generate OAuth URL for a workspace/tenant connection
* [generateLinkUserOAuthUrl](docs/sdks/integrations/README.md#generatelinkuseroauthurl) - Generate OAuth URL to link a subscriber user identity
* [~~generateChatOAuthUrl~~](docs/sdks/integrations/README.md#generatechatoauthurl) - Generate chat OAuth URL :warning: **Deprecated**
### [Layouts](docs/sdks/layouts/README.md)
* [create](docs/sdks/layouts/README.md#create) - Create a layout
* [list](docs/sdks/layouts/README.md#list) - List all layouts
* [update](docs/sdks/layouts/README.md#update) - Update a layout
* [retrieve](docs/sdks/layouts/README.md#retrieve) - Retrieve a layout
* [delete](docs/sdks/layouts/README.md#delete) - Delete a layout
* [duplicate](docs/sdks/layouts/README.md#duplicate) - Duplicate a layout
* [generatePreview](docs/sdks/layouts/README.md#generatepreview) - Generate layout preview
* [usage](docs/sdks/layouts/README.md#usage) - Get layout usage
### [Messages](docs/sdks/messages/README.md)
* [retrieve](docs/sdks/messages/README.md#retrieve) - List all messages
* [delete](docs/sdks/messages/README.md#delete) - Delete a message
* [deleteByTransactionId](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
### [Notifications](docs/sdks/notifications/README.md)
* [list](docs/sdks/notifications/README.md#list) - List all events
* [retrieve](docs/sdks/notifications/README.md#retrieve) - Retrieve an event
### [Subscribers](docs/sdks/subscribers/README.md)
* [search](docs/sdks/subscribers/README.md#search) - Search subscribers
* [create](docs/sdks/subscribers/README.md#create) - Create a subscriber
* [retrieve](docs/sdks/subscribers/README.md#retrieve) - Retrieve a subscriber
* [patch](docs/sdks/subscribers/README.md#patch) - Update a subscriber
* [delete](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
* [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
#### [Subscribers.Credentials](docs/sdks/credentials/README.md)
* [update](docs/sdks/credentials/README.md#update) - Update provider credentials
* [append](docs/sdks/credentials/README.md#append) - Upsert provider credentials
* [delete](docs/sdks/credentials/README.md#delete) - Delete provider credentials
#### [Subscribers.Messages](docs/sdks/novumessages/README.md)
* [updateAsSeen](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status
* [markAll](docs/sdks/novumessages/README.md#markall) - Update all notifications state
* [markAllAs](docs/sdks/novumessages/README.md#markallas) - Update notifications state
#### [Subscribers.Notifications](docs/sdks/novunotifications/README.md)
* [list](docs/sdks/novunotifications/README.md#list) - Retrieve subscriber notifications
* [delete](docs/sdks/novunotifications/README.md#delete) - Delete a notification
* [completeAction](docs/sdks/novunotifications/README.md#completeaction) - Complete a notification action
* [revertAction](docs/sdks/novunotifications/README.md#revertaction) - Revert a notification action
* [archive](docs/sdks/novunotifications/README.md#archive) - Archive a notification
* [markAsRead](docs/sdks/novunotifications/README.md#markasread) - Mark a notification as read
* [snooze](docs/sdks/novunotifications/README.md#snooze) - Snooze a notification
* [unarchive](docs/sdks/novunotifications/README.md#unarchive) - Unarchive a notification
* [markAsUnread](docs/sdks/novunotifications/README.md#markasunread) - Mark a notification as unread
* [unsnooze](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze a notification
* [archiveAll](docs/sdks/novunotifications/README.md#archiveall) - Archive all notifications
* [count](docs/sdks/novunotifications/README.md#count) - Retrieve subscriber notifications count
* [deleteAll](docs/sdks/novunotifications/README.md#deleteall) - Delete all notifications
* [markAllAsRead](docs/sdks/novunotifications/README.md#markallasread) - Mark all notifications as read
* [archiveAllRead](docs/sdks/novunotifications/README.md#archiveallread) - Archive all read notifications
* [markAsSeen](docs/sdks/novunotifications/README.md#markasseen) - Mark notifications as seen
* [feed](docs/sdks/novunotifications/README.md#feed) - Retrieve subscriber notifications
* [unseenCount](docs/sdks/novunotifications/README.md#unseencount) - Retrieve unseen notifications count
#### [Subscribers.Preferences](docs/sdks/preferences/README.md)
* [list](docs/sdks/preferences/README.md#list) - Retrieve subscriber preferences
* [update](docs/sdks/preferences/README.md#update) - Update subscriber preferences
* [bulkUpdate](docs/sdks/preferences/README.md#bulkupdate) - Bulk update subscriber preferences
#### [Subscribers.Properties](docs/sdks/properties/README.md)
* [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
#### [Subscribers.Topics](docs/sdks/novutopics/README.md)
* [list](docs/sdks/novutopics/README.md#list) - Retrieve subscriber subscriptions
### [Topics](docs/sdks/topics/README.md)
* [list](docs/sdks/topics/README.md#list) - List all topics
* [create](docs/sdks/topics/README.md#create) - Create a topic
* [get](docs/sdks/topics/README.md#get) - Retrieve a topic
* [update](docs/sdks/topics/README.md#update) - Update a topic
* [delete](docs/sdks/topics/README.md#delete) - Delete a topic
#### [Topics.Subscribers](docs/sdks/novusubscribers/README.md)
* [retrieve](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
#### [Topics.Subscriptions](docs/sdks/subscriptions/README.md)
* [list](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
* [create](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
* [delete](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
* [getSubscription](docs/sdks/subscriptions/README.md#getsubscription) - Retrieve a topic subscription
* [update](docs/sdks/subscriptions/README.md#update) - Update a topic subscription
### [Translations](docs/sdks/translations/README.md)
* [create](docs/sdks/translations/README.md#create) - Create a translation
* [retrieve](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
* [delete](docs/sdks/translations/README.md#delete) - Delete a translation
* [upload](docs/sdks/translations/README.md#upload) - Upload translation files
#### [Translations.Groups](docs/sdks/groups/README.md)
* [delete](docs/sdks/groups/README.md#delete) - Delete a translation group
* [retrieve](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group
#### [Translations.Master](docs/sdks/master/README.md)
* [retrieve](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
* [import](docs/sdks/master/README.md#import) - Import master translations JSON
* [upload](docs/sdks/master/README.md#upload) - Upload master translations JSON file
### [Workflows](docs/sdks/workflows/README.md)
* [create](docs/sdks/workflows/README.md#create) - Create a workflow
* [list](docs/sdks/workflows/README.md#list) - List all workflows
* [update](docs/sdks/workflows/README.md#update) - Update a workflow
* [get](docs/sdks/workflows/README.md#get) - Retrieve a workflow
* [delete](docs/sdks/workflows/README.md#delete) - Delete a workflow
* [patch](docs/sdks/workflows/README.md#patch) - Update a workflow
* [sync](docs/sdks/workflows/README.md#sync) - Sync a workflow
#### [Workflows.Steps](docs/sdks/steps/README.md)
* [generatePreview](docs/sdks/steps/README.md#generatepreview) - Generate a step preview
* [retrieve](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
## 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](./FUNCTIONS.md).
Available standalone functions
- [`activityTrack`](docs/sdks/activity/README.md#track) - Track provider activity and engagement events
- [`cancel`](docs/sdks/novu/README.md#cancel) - Cancel triggered event
- [`channelConnectionsCreate`](docs/sdks/channelconnections/README.md#create) - Create a channel connection
- [`channelConnectionsDelete`](docs/sdks/channelconnections/README.md#delete) - Delete a channel connection
- [`channelConnectionsList`](docs/sdks/channelconnections/README.md#list) - List all channel connections
- [`channelConnectionsRetrieve`](docs/sdks/channelconnections/README.md#retrieve) - Retrieve a channel connection
- [`channelConnectionsUpdate`](docs/sdks/channelconnections/README.md#update) - Update a channel connection
- [`channelEndpointsCreate`](docs/sdks/channelendpoints/README.md#create) - Create a channel endpoint
- [`channelEndpointsDelete`](docs/sdks/channelendpoints/README.md#delete) - Delete a channel endpoint
- [`channelEndpointsList`](docs/sdks/channelendpoints/README.md#list) - List all channel endpoints
- [`channelEndpointsRetrieve`](docs/sdks/channelendpoints/README.md#retrieve) - Retrieve a channel endpoint
- [`channelEndpointsUpdate`](docs/sdks/channelendpoints/README.md#update) - Update a channel endpoint
- [`contextsCreate`](docs/sdks/contexts/README.md#create) - Create a context
- [`contextsDelete`](docs/sdks/contexts/README.md#delete) - Delete a context
- [`contextsList`](docs/sdks/contexts/README.md#list) - List all contexts
- [`contextsRetrieve`](docs/sdks/contexts/README.md#retrieve) - Retrieve a context
- [`contextsUpdate`](docs/sdks/contexts/README.md#update) - Update a context
- [`domainsAutoConfigureRetrieve`](docs/sdks/autoconfigure/README.md#retrieve) - Retrieve auto-configuration availability
- [`domainsAutoConfigureStart`](docs/sdks/autoconfigure/README.md#start) - Start DNS auto-configuration
- [`domainsCreate`](docs/sdks/domains/README.md#create) - Create a domain
- [`domainsDelete`](docs/sdks/domains/README.md#delete) - Delete a domain
- [`domainsDiagnose`](docs/sdks/domains/README.md#diagnose) - Diagnose inbound DNS for a domain
- [`domainsList`](docs/sdks/domains/README.md#list) - List domains for an environment
- [`domainsRetrieve`](docs/sdks/domains/README.md#retrieve) - Retrieve a domain by name
- [`domainsRoutesCreate`](docs/sdks/routes/README.md#create) - Create a route
- [`domainsRoutesDelete`](docs/sdks/routes/README.md#delete) - Delete a route
- [`domainsRoutesList`](docs/sdks/routes/README.md#list) - List routes for a domain
- [`domainsRoutesRetrieve`](docs/sdks/routes/README.md#retrieve) - Retrieve a route by address
- [`domainsRoutesTest`](docs/sdks/routes/README.md#test) - Test an inbound route
- [`domainsRoutesUpdate`](docs/sdks/routes/README.md#update) - Update a route
- [`domainsUpdate`](docs/sdks/domains/README.md#update) - Update a domain
- [`domainsVerify`](docs/sdks/domains/README.md#verify) - Verify a domain
- [`environmentsCreate`](docs/sdks/environments/README.md#create) - Create an environment
- [`environmentsDelete`](docs/sdks/environments/README.md#delete) - Delete an environment
- [`environmentsDiff`](docs/sdks/environments/README.md#diff) - Compare resources between environments
- [`environmentsGetTags`](docs/sdks/environments/README.md#gettags) - List environment tags
- [`environmentsList`](docs/sdks/environments/README.md#list) - List all environments
- [`environmentsPublish`](docs/sdks/environments/README.md#publish) - Publish resources to target environment
- [`environmentsUpdate`](docs/sdks/environments/README.md#update) - Update an environment
- [`environmentVariablesCreate`](docs/sdks/environmentvariables/README.md#create) - Create a variable
- [`environmentVariablesDelete`](docs/sdks/environmentvariables/README.md#delete) - Delete environment variable
- [`environmentVariablesList`](docs/sdks/environmentvariables/README.md#list) - List all variables
- [`environmentVariablesRetrieve`](docs/sdks/environmentvariables/README.md#retrieve) - Get environment variable
- [`environmentVariablesUpdate`](docs/sdks/environmentvariables/README.md#update) - Update a variable
- [`environmentVariablesUsage`](docs/sdks/environmentvariables/README.md#usage) - Retrieve a variable usage
- [`integrationsCreate`](docs/sdks/integrations/README.md#create) - Create an integration
- [`integrationsDelete`](docs/sdks/integrations/README.md#delete) - Delete an integration
- [`integrationsGenerateConnectOAuthUrl`](docs/sdks/integrations/README.md#generateconnectoauthurl) - Generate OAuth URL for a workspace/tenant connection
- [`integrationsGenerateLinkUserOAuthUrl`](docs/sdks/integrations/README.md#generatelinkuseroauthurl) - Generate OAuth URL to link a subscriber user identity
- [`integrationsIntegrationsControllerAutoConfigureIntegration`](docs/sdks/integrations/README.md#integrationscontrollerautoconfigureintegration) - Auto-configure an integration for inbound webhooks
- [`integrationsList`](docs/sdks/integrations/README.md#list) - List all integrations
- [`integrationsListActive`](docs/sdks/integrations/README.md#listactive) - List active integrations
- [`integrationsSetAsPrimary`](docs/sdks/integrations/README.md#setasprimary) - Update integration as primary
- [`integrationsUpdate`](docs/sdks/integrations/README.md#update) - Update an integration
- [`layoutsCreate`](docs/sdks/layouts/README.md#create) - Create a layout
- [`layoutsDelete`](docs/sdks/layouts/README.md#delete) - Delete a layout
- [`layoutsDuplicate`](docs/sdks/layouts/README.md#duplicate) - Duplicate a layout
- [`layoutsGeneratePreview`](docs/sdks/layouts/README.md#generatepreview) - Generate layout preview
- [`layoutsList`](docs/sdks/layouts/README.md#list) - List all layouts
- [`layoutsRetrieve`](docs/sdks/layouts/README.md#retrieve) - Retrieve a layout
- [`layoutsUpdate`](docs/sdks/layouts/README.md#update) - Update a layout
- [`layoutsUsage`](docs/sdks/layouts/README.md#usage) - Get layout usage
- [`messagesDelete`](docs/sdks/messages/README.md#delete) - Delete a message
- [`messagesDeleteByTransactionId`](docs/sdks/messages/README.md#deletebytransactionid) - Delete messages by transactionId
- [`messagesRetrieve`](docs/sdks/messages/README.md#retrieve) - List all messages
- [`notificationsList`](docs/sdks/notifications/README.md#list) - List all events
- [`notificationsRetrieve`](docs/sdks/notifications/README.md#retrieve) - Retrieve an event
- [`subscribersCreate`](docs/sdks/subscribers/README.md#create) - Create a subscriber
- [`subscribersCreateBulk`](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
- [`subscribersCredentialsAppend`](docs/sdks/credentials/README.md#append) - Upsert provider credentials
- [`subscribersCredentialsDelete`](docs/sdks/credentials/README.md#delete) - Delete provider credentials
- [`subscribersCredentialsUpdate`](docs/sdks/credentials/README.md#update) - Update provider credentials
- [`subscribersDelete`](docs/sdks/subscribers/README.md#delete) - Delete a subscriber
- [`subscribersMessagesMarkAll`](docs/sdks/novumessages/README.md#markall) - Update all notifications state
- [`subscribersMessagesMarkAllAs`](docs/sdks/novumessages/README.md#markallas) - Update notifications state
- [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Update notification action status
- [`subscribersNotificationsArchive`](docs/sdks/novunotifications/README.md#archive) - Archive a notification
- [`subscribersNotificationsArchiveAll`](docs/sdks/novunotifications/README.md#archiveall) - Archive all notifications
- [`subscribersNotificationsArchiveAllRead`](docs/sdks/novunotifications/README.md#archiveallread) - Archive all read notifications
- [`subscribersNotificationsCompleteAction`](docs/sdks/novunotifications/README.md#completeaction) - Complete a notification action
- [`subscribersNotificationsCount`](docs/sdks/novunotifications/README.md#count) - Retrieve subscriber notifications count
- [`subscribersNotificationsDelete`](docs/sdks/novunotifications/README.md#delete) - Delete a notification
- [`subscribersNotificationsDeleteAll`](docs/sdks/novunotifications/README.md#deleteall) - Delete all notifications
- [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Retrieve subscriber notifications
- [`subscribersNotificationsList`](docs/sdks/novunotifications/README.md#list) - Retrieve subscriber notifications
- [`subscribersNotificationsMarkAllAsRead`](docs/sdks/novunotifications/README.md#markallasread) - Mark all notifications as read
- [`subscribersNotificationsMarkAsRead`](docs/sdks/novunotifications/README.md#markasread) - Mark a notification as read
- [`subscribersNotificationsMarkAsSeen`](docs/sdks/novunotifications/README.md#markasseen) - Mark notifications as seen
- [`subscribersNotificationsMarkAsUnread`](docs/sdks/novunotifications/README.md#markasunread) - Mark a notification as unread
- [`subscribersNotificationsRevertAction`](docs/sdks/novunotifications/README.md#revertaction) - Revert a notification action
- [`subscribersNotificationsSnooze`](docs/sdks/novunotifications/README.md#snooze) - Snooze a notification
- [`subscribersNotificationsUnarchive`](docs/sdks/novunotifications/README.md#unarchive) - Unarchive a notification
- [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Retrieve unseen notifications count
- [`subscribersNotificationsUnsnooze`](docs/sdks/novunotifications/README.md#unsnooze) - Unsnooze a notification
- [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Update a subscriber
- [`subscribersPreferencesBulkUpdate`](docs/sdks/preferences/README.md#bulkupdate) - Bulk update subscriber preferences
- [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Retrieve subscriber preferences
- [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber preferences
- [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
- [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Retrieve a subscriber
- [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search subscribers
- [`subscribersTopicsList`](docs/sdks/novutopics/README.md#list) - Retrieve subscriber subscriptions
- [`topicsCreate`](docs/sdks/topics/README.md#create) - Create a topic
- [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete a topic
- [`topicsGet`](docs/sdks/topics/README.md#get) - Retrieve a topic
- [`topicsList`](docs/sdks/topics/README.md#list) - List all topics
- [`topicsSubscribersRetrieve`](docs/sdks/novusubscribers/README.md#retrieve) - Check topic subscriber
- [`topicsSubscriptionsCreate`](docs/sdks/subscriptions/README.md#create) - Create topic subscriptions
- [`topicsSubscriptionsDelete`](docs/sdks/subscriptions/README.md#delete) - Delete topic subscriptions
- [`topicsSubscriptionsGetSubscription`](docs/sdks/subscriptions/README.md#getsubscription) - Retrieve a topic subscription
- [`topicsSubscriptionsList`](docs/sdks/subscriptions/README.md#list) - List topic subscriptions
- [`topicsSubscriptionsUpdate`](docs/sdks/subscriptions/README.md#update) - Update a topic subscription
- [`topicsUpdate`](docs/sdks/topics/README.md#update) - Update a topic
- [`translationsCreate`](docs/sdks/translations/README.md#create) - Create a translation
- [`translationsDelete`](docs/sdks/translations/README.md#delete) - Delete a translation
- [`translationsGroupsDelete`](docs/sdks/groups/README.md#delete) - Delete a translation group
- [`translationsGroupsRetrieve`](docs/sdks/groups/README.md#retrieve) - Retrieve a translation group
- [`translationsMasterImport`](docs/sdks/master/README.md#import) - Import master translations JSON
- [`translationsMasterRetrieve`](docs/sdks/master/README.md#retrieve) - Retrieve master translations JSON
- [`translationsMasterUpload`](docs/sdks/master/README.md#upload) - Upload master translations JSON file
- [`translationsRetrieve`](docs/sdks/translations/README.md#retrieve) - Retrieve a translation
- [`translationsUpload`](docs/sdks/translations/README.md#upload) - Upload translation files
- [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
- [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
- [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
- [`workflowsCreate`](docs/sdks/workflows/README.md#create) - Create a workflow
- [`workflowsDelete`](docs/sdks/workflows/README.md#delete) - Delete a workflow
- [`workflowsGet`](docs/sdks/workflows/README.md#get) - Retrieve a workflow
- [`workflowsList`](docs/sdks/workflows/README.md#list) - List all workflows
- [`workflowsPatch`](docs/sdks/workflows/README.md#patch) - Update a workflow
- [`workflowsStepsGeneratePreview`](docs/sdks/steps/README.md#generatepreview) - Generate a step preview
- [`workflowsStepsRetrieve`](docs/sdks/steps/README.md#retrieve) - Retrieve workflow step
- [`workflowsSync`](docs/sdks/workflows/README.md#sync) - Sync a workflow
- [`workflowsUpdate`](docs/sdks/workflows/README.md#update) - Update a workflow
- ~~[`integrationsGenerateChatOAuthUrl`](docs/sdks/integrations/README.md#generatechatoauthurl)~~ - Generate chat OAuth URL :warning: **Deprecated**
## Error Handling
[`NovuError`](./src/models/errors/novuerror.ts) 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](#error-classes). |
### Example
```typescript
import { Novu } from "@novu/api";
import * as errors from "@novu/api/models/errors";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
try {
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);
} catch (error) {
// The base class for HTTP error responses
if (error instanceof errors.NovuError) {
console.log(error.message);
console.log(error.statusCode);
console.log(error.body);
console.log(error.headers);
// Depending on the method different errors may be thrown
if (error instanceof errors.PayloadValidationExceptionDto) {
console.log(error.data$.statusCode); // number
console.log(error.data$.timestamp); // string
console.log(error.data$.path); // string
console.log(error.data$.message); // errors.PayloadValidationExceptionDtoMessage
console.log(error.data$.ctx); // { [k: string]: any }
}
}
}
}
run();
```
### Error Classes
**Primary errors:**
* [`NovuError`](./src/models/errors/novuerror.ts): The base class for HTTP error responses.
* [`ErrorDto`](./src/models/errors/errordto.ts): *
* [`ValidationErrorDto`](./src/models/errors/validationerrordto.ts): Unprocessable Entity. Status code `422`. *
Less common errors (9)
**Network errors:**
* [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server.
* [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal.
* [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client.
* [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid.
* [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error.
**Inherit from [`NovuError`](./src/models/errors/novuerror.ts)**:
* [`PayloadValidationExceptionDto`](./src/models/errors/payloadvalidationexceptiondto.ts): Status code `400`. Applicable to 3 of 135 methods.*
* [`SubscriberResponseDto`](./src/models/errors/subscriberresponsedto.ts): Created. Status code `409`. Applicable to 1 of 135 methods.*
* [`TopicResponseDto`](./src/models/errors/topicresponsedto.ts): OK. Status code `409`. Applicable to 1 of 135 methods.*
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
## 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
```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();
```
### 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:
```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](https://developer.mozilla.org/en-US/docs/Web/API/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:
- route requests through a proxy server using [undici](https://www.npmjs.com/package/undici)'s ProxyAgent
- use the `"beforeRequest"` hook to add a custom header and a timeout to requests
- use the `"requestError"` hook to log errors
```typescript
import { Novu } from "@novu/api";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@novu/api/lib/http";
const dispatcher = new ProxyAgent("http://proxy.example.com:8080");
const httpClient = new HTTPClient({
// 'fetcher' takes a function that has the same signature as native 'fetch'.
fetcher: (input, init) =>
// 'dispatcher' is specific to undici and not part of the standard Fetch API.
fetch(input, { ...init, dispatcher } as RequestInit),
});
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
### 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:
```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`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-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`](https://developer.mozilla.org/en-US/docs/Web/API/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`](https://www.npmjs.com/package/fetch-blob).
```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",
},
},
undefined,
{
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!
### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
