@novu/api
Advanced tools
npm add @novu/api
yarn add @novu/api
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { Novu } from "@novu/api";
import { TopicPayloadDtoType } from "@novu/api/models/components";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.trigger({
name: "workflow_identifier",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.Topic,
},
],
});
// Handle the result
console.log(result);
}
run();
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(7685.78, 10);
for await (const page of result) {
// handle page
}
}
run();
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 { TopicPayloadDtoType } from "@novu/api/models/components";
import * as errors 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",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.Topic,
},
],
});
} catch (err) {
switch (true) {
case err instanceof errors.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;
}
}
}
// Handle the result
console.log(result);
}
run();
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";
import { TopicPayloadDtoType } from "@novu/api/models/components";
const novu = new Novu({
serverIdx: 1,
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.trigger({
name: "workflow_identifier",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.Topic,
},
],
});
// Handle the result
console.log(result);
}
run();
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";
import { TopicPayloadDtoType } from "@novu/api/models/components";
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",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.Topic,
},
],
});
// Handle the result
console.log(result);
}
run();
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 });
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";
import { TopicPayloadDtoType } from "@novu/api/models/components";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.trigger({
name: "workflow_identifier",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.Topic,
},
],
});
// Handle the result
console.log(result);
}
run();
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";
import { TopicPayloadDtoType } from "@novu/api/models/components";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.trigger(
{
name: "workflow_identifier",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.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";
import { TopicPayloadDtoType } from "@novu/api/models/components";
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",
overrides: {},
payload: {},
to: [
{
topicKey: "topic_key",
type: TopicPayloadDtoType.Topic,
},
],
});
// Handle the result
console.log(result);
}
run();
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.
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!
FAQs
Novu is an open-source notification infrastructure. <img src="https://i
The npm package @novu/api receives a total of 349 weekly downloads. As such, @novu/api popularity was classified as not popular.
We found that @novu/api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Newly introduced telemetry in devenv 1.4 sparked a backlash over privacy concerns, leading to the removal of its AI-powered feature after strong community pushback.
Security News
TC39 met in Seattle and advanced 9 JavaScript proposals, including three to Stage 4, introducing new features and enhancements for a future ECMAScript release.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.