import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.delete("integrationId");
// Get integrations
use Novu\SDK\Novu;
$novu = new Novu('<NOVU_API_KEY>');
$novu->deleteIntegration($integrationId);
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.delete_integration('<insert-provider-id>')
from novu.api import IntegrationApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = IntegrationApi(url, api_key).delete(
integration_id="<The integration ID>",
)
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.deleteIntegration(integrationId);
}
}
{
"data": [
{
"_id": "string",
"_environmentId": "string",
"_organizationId": "string",
"name": "string",
"identifier": "string",
"providerId": "string",
"channel": "in_app",
"credentials": {
"apiKey": "string",
"user": "string",
"secretKey": "string",
"domain": "string",
"password": "string",
"host": "string",
"port": "string",
"secure": true,
"region": "string",
"accountSid": "string",
"messageProfileId": "string",
"token": "string",
"from": "string",
"senderName": "string",
"projectName": "string",
"applicationId": "string",
"clientId": "string",
"requireTls": true,
"ignoreTls": true,
"tlsOptions": {},
"baseUrl": "string",
"webhookUrl": "string",
"redirectUrl": "string",
"hmac": true,
"serviceAccount": "string",
"ipPoolName": "string"
},
"active": true,
"deleted": true,
"deletedAt": "string",
"deletedBy": "string",
"primary": true
}
]
}
Integrations
Delete an integration
Delete an integration by its unique key identifier integrationId. This action is irreversible. Only integration metadata is returned, credentials field is returned as empty object.
DELETE
/
v1
/
integrations
/
{integrationId}
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.delete("integrationId");
// Get integrations
use Novu\SDK\Novu;
$novu = new Novu('<NOVU_API_KEY>');
$novu->deleteIntegration($integrationId);
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.delete_integration('<insert-provider-id>')
from novu.api import IntegrationApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = IntegrationApi(url, api_key).delete(
integration_id="<The integration ID>",
)
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.deleteIntegration(integrationId);
}
}
{
"data": [
{
"_id": "string",
"_environmentId": "string",
"_organizationId": "string",
"name": "string",
"identifier": "string",
"providerId": "string",
"channel": "in_app",
"credentials": {
"apiKey": "string",
"user": "string",
"secretKey": "string",
"domain": "string",
"password": "string",
"host": "string",
"port": "string",
"secure": true,
"region": "string",
"accountSid": "string",
"messageProfileId": "string",
"token": "string",
"from": "string",
"senderName": "string",
"projectName": "string",
"applicationId": "string",
"clientId": "string",
"requireTls": true,
"ignoreTls": true,
"tlsOptions": {},
"baseUrl": "string",
"webhookUrl": "string",
"redirectUrl": "string",
"hmac": true,
"serviceAccount": "string",
"ipPoolName": "string"
},
"active": true,
"deleted": true,
"deletedAt": "string",
"deletedBy": "string",
"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.delete("integrationId");
// Get integrations
use Novu\SDK\Novu;
$novu = new Novu('<NOVU_API_KEY>');
$novu->deleteIntegration($integrationId);
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.delete_integration('<insert-provider-id>')
from novu.api import IntegrationApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = IntegrationApi(url, api_key).delete(
integration_id="<The integration ID>",
)
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.deleteIntegration(integrationId);
}
}
{
"data": [
{
"_id": "string",
"_environmentId": "string",
"_organizationId": "string",
"name": "string",
"identifier": "string",
"providerId": "string",
"channel": "in_app",
"credentials": {
"apiKey": "string",
"user": "string",
"secretKey": "string",
"domain": "string",
"password": "string",
"host": "string",
"port": "string",
"secure": true,
"region": "string",
"accountSid": "string",
"messageProfileId": "string",
"token": "string",
"from": "string",
"senderName": "string",
"projectName": "string",
"applicationId": "string",
"clientId": "string",
"requireTls": true,
"ignoreTls": true,
"tlsOptions": {},
"baseUrl": "string",
"webhookUrl": "string",
"redirectUrl": "string",
"hmac": true,
"serviceAccount": "string",
"ipPoolName": "string"
},
"active": true,
"deleted": true,
"deletedAt": "string",
"deletedBy": "string",
"primary": true
}
]
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Response
Ok
Available options:
in_app, email, sms, chat, push Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I