Integrations
Delete integration
- 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 preferences by level
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed messages as seen or as read
- 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 override
- 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
Delete integration
DELETE
/
v1
/
integrations
/
{integrationId}
Authorization
string
*
Authorization
Required
string
integrationId
string
*
integrationId
Required
string
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.delete("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 18d2e625f05d80e
Path Parameters
integrationId
string
requiredResponse
200 - application/json
data
object[]
data._id
string
data._environmentId
string
requireddata._organizationId
string
requireddata.name
string
requireddata.identifier
string
requireddata.providerId
string
requireddata.channel
enum<string>
requiredAvailable options:
in_app
, email
, sms
, chat
, push
data.credentials
object
requireddata.credentials.apiKey
string
data.credentials.user
string
data.credentials.secretKey
string
data.credentials.domain
string
data.credentials.password
string
data.credentials.host
string
data.credentials.port
string
data.credentials.secure
boolean
data.credentials.region
string
data.credentials.accountSid
string
data.credentials.messageProfileId
string
data.credentials.token
string
data.credentials.from
string
data.credentials.senderName
string
data.credentials.projectName
string
data.credentials.applicationId
string
data.credentials.clientId
string
data.credentials.requireTls
boolean
data.credentials.ignoreTls
boolean
data.credentials.tlsOptions
object
data.credentials.baseUrl
string
data.credentials.webhookUrl
string
data.credentials.redirectUrl
string
data.credentials.hmac
boolean
data.credentials.serviceAccount
string
data.credentials.ipPoolName
string
data.credentials.apiKeyRequestHeader
string
data.credentials.secretKeyRequestHeader
string
data.credentials.idPath
string
data.credentials.datePath
string
data.credentials.apiToken
string
data.credentials.authenticateByToken
boolean
data.credentials.authenticationTokenKey
string
data.credentials.instanceId
string
data.credentials.alertUid
string
data.credentials.title
string
data.credentials.imageUrl
string
data.credentials.state
string
data.credentials.externalLink
string
data.credentials.channelId
string
data.credentials.phoneNumberIdentification
string
data.active
boolean
requireddata.deleted
boolean
requireddata.deletedAt
string
requireddata.deletedBy
string
requireddata.primary
boolean
requireddata.conditions
object[]
data.conditions.isNegated
boolean
requireddata.conditions.type
enum<string>
requiredAvailable options:
BOOLEAN
, TEXT
, DATE
, NUMBER
, STATEMENT
, LIST
, MULTI_LIST
, GROUP
data.conditions.value
enum<string>
requiredAvailable options:
AND
, OR
data.conditions.children
object[]
requireddata.conditions.children.field
string
requireddata.conditions.children.value
string
requireddata.conditions.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
data.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.delete("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
}
]
}