import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.getActive();
// Get integrations
use Novu\SDK\Novu;
$novu = new Novu(<NOVU_API_KEY>);
$novu->getActiveIntegrations()->toArray();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.active_integrations()
from novu.api import IntegrationApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = IntegrationApi(url, api_key).list(
only_active=true # This allows one to retrieve only active integrations. Defaults to False.
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.activeIntegrations()
}
}
{
_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
}
Integrations
List active integrations
List all the active integrations created in the organization. Only integration metadata is returned, credentials field is returned as an empty object.
GET
/
v1
/
integrations
/
active
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.getActive();
// Get integrations
use Novu\SDK\Novu;
$novu = new Novu(<NOVU_API_KEY>);
$novu->getActiveIntegrations()->toArray();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.active_integrations()
from novu.api import IntegrationApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = IntegrationApi(url, api_key).list(
only_active=true # This allows one to retrieve only active integrations. Defaults to False.
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.activeIntegrations()
}
}
{
_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 18d2e625f05d80eimport { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.getActive();
// Get integrations
use Novu\SDK\Novu;
$novu = new Novu(<NOVU_API_KEY>);
$novu->getActiveIntegrations()->toArray();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.active_integrations()
from novu.api import IntegrationApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = IntegrationApi(url, api_key).list(
only_active=true # This allows one to retrieve only active integrations. Defaults to False.
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.activeIntegrations()
}
}
{
_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
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Response
The list of active integrations belonging to the organization that are successfully returned.
Available options:
in_app, email, sms, chat, push Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?