Integrations
Get active integrations
Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
GET
/v1/integrations/active
Authorization*
Please ensure there is a space between ApiKey
and your Api key.
E.g ApiKey 18d2e625f05d80e
import { Novu } from '@novu/node';
export const novu = new Novu('<REPLACE_WITH_API_KEY_FROM_ADMIN_PANEL>');
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
}
Response
200 - application/json
_environmentIdrequired
string
_id
string
_organizationIdrequired
string
activerequired
boolean
channelrequired
enum<string>
Available options:
in_app
, email
, sms
, chat
, push
credentialsrequired
object
deletedrequired
boolean
deletedAtrequired
string
deletedByrequired
string
identifierrequired
string
namerequired
string
primaryrequired
boolean
providerIdrequired
string
import { Novu } from '@novu/node';
export const novu = new Novu('<REPLACE_WITH_API_KEY_FROM_ADMIN_PANEL>');
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
}