GET
/
v1
/
integrations
/
active
import { Novu } from '@novu/node';

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

await novu.integrations.getActive();


{
    _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
}

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

E.g ApiKey 18d2e625f05d80e

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

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

await novu.integrations.getActive();


{
    _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
}

Authorizations

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

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
​
active
boolean
required
​
deleted
boolean
required
​
deletedAt
string
required
​
deletedBy
string
required
​
primary
boolean
required
​
_id
string
​
conditions
object[]

Was this page helpful?