Get active integrations

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Node.js

import { Novu } from '@novu/node'; 

const novu = new Novu('<NOVU_API_KEY>');

await novu.integrations.getActive();

Response

{
    _id: "_id",
    _environmentId: "_environmentId",
    _organizationId: "_organizationId",
    name: "name",
    identifier: "identifier",
    providerId: "providerId",
    channel: "channel",
    credentials: credentials,
    active: true,
    deleted: true,
    deletedAt: "deletedAt",
    deletedBy: "deletedBy",
    primary: true
}

Response

200

application/json

The list of active integrations belonging to the organization that are successfully returned.

_environmentId · string · required

_organizationId · string · required

name · string · required

identifier · string · required

providerId · string · required

channel · enum<string> · required

Available options:

in_app,

email,

sms,

chat,

push

credentials · object · required

Show child attributes

active · boolean · required

deleted · boolean · required

deletedAt · string · required

deletedBy · string · required

primary · boolean · required

_id · string

conditions · object[]

Show child attributes