- API Reference
- Discord Support
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerid
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preference
- GETGet in app notification feed for a particular subscriber
- GETGet the unseen in app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read unread seen or unseen optionally you can pass feed id or array to mark messages of a particular feed
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Integrations
Get active integrations
GET
/
v1
/
integrations
/
active
Authorization
string
*
Authorization
Required
string
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_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
Response
200 - application/json
_id
string
_environmentId
string
required_organizationId
string
requiredname
string
requiredidentifier
string
requiredproviderId
string
requiredchannel
enum<string>
requiredAvailable options:
in_app
, email
, sms
, chat
, push
credentials
object
requiredcredentials.apiKey
string
credentials.user
string
credentials.secretKey
string
credentials.domain
string
credentials.password
string
credentials.host
string
credentials.port
string
credentials.secure
boolean
credentials.region
string
credentials.accountSid
string
credentials.messageProfileId
string
credentials.token
string
credentials.from
string
credentials.senderName
string
credentials.projectName
string
credentials.applicationId
string
credentials.clientId
string
credentials.requireTls
boolean
credentials.ignoreTls
boolean
credentials.tlsOptions
object
credentials.baseUrl
string
credentials.webhookUrl
string
credentials.redirectUrl
string
credentials.hmac
boolean
credentials.serviceAccount
string
credentials.ipPoolName
string
credentials.apiKeyRequestHeader
string
credentials.secretKeyRequestHeader
string
credentials.idPath
string
credentials.datePath
string
credentials.apiToken
string
credentials.authenticateByToken
boolean
credentials.authenticationTokenKey
string
credentials.instanceId
string
credentials.alertUid
string
credentials.title
string
credentials.imageUrl
string
credentials.state
string
credentials.externalLink
string
credentials.channelId
string
active
boolean
requireddeleted
boolean
requireddeletedAt
string
requireddeletedBy
string
requiredprimary
boolean
requiredconditions
object[]
conditions.isNegated
boolean
requiredconditions.type
enum<string>
requiredAvailable options:
BOOLEAN
, TEXT
, DATE
, NUMBER
, STATEMENT
, LIST
, MULTI_LIST
, GROUP
conditions.value
enum<string>
requiredAvailable options:
AND
, OR
conditions.children
object[]
requiredconditions.children.field
string
requiredconditions.children.value
string
requiredconditions.children.operator
enum<string>
requiredAvailable options:
LARGER
, SMALLER
, LARGER_EQUAL
, SMALLER_EQUAL
, EQUAL
, NOT_EQUAL
, ALL_IN
, ANY_IN
, NOT_IN
, BETWEEN
, NOT_BETWEEN
, LIKE
, NOT_LIKE
, IN
conditions.children.on
enum<string>
requiredAvailable options:
subscriber
, payload
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_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
}