- 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
Update integration
PUT
/
v1
/
integrations
/
{integrationId}
Authorization
string
*
Authorization
Required
string
integrationId
string
*
integrationId
Required
string
object
*
name
string
name
string
identifier
string
identifier
string
_environmentId
string
_environmentId
string
active
boolean
active
boolean
If the integration is active the validation on the credentials field will run
credentials
object
credentials
object
apiKey
string
apiKey
string
user
string
user
string
secretKey
string
secretKey
string
domain
string
domain
string
password
string
password
string
host
string
host
string
port
string
port
string
secure
boolean
secure
boolean
region
string
region
string
accountSid
string
accountSid
string
messageProfileId
string
messageProfileId
string
token
string
token
string
from
string
from
string
senderName
string
senderName
string
projectName
string
projectName
string
applicationId
string
applicationId
string
clientId
string
clientId
string
requireTls
boolean
requireTls
boolean
ignoreTls
boolean
ignoreTls
boolean
tlsOptions
object
tlsOptions
object
baseUrl
string
baseUrl
string
webhookUrl
string
webhookUrl
string
redirectUrl
string
redirectUrl
string
hmac
boolean
hmac
boolean
serviceAccount
string
serviceAccount
string
ipPoolName
string
ipPoolName
string
apiKeyRequestHeader
string
apiKeyRequestHeader
string
secretKeyRequestHeader
string
secretKeyRequestHeader
string
idPath
string
idPath
string
datePath
string
datePath
string
apiToken
string
apiToken
string
authenticateByToken
boolean
authenticateByToken
boolean
authenticationTokenKey
string
authenticationTokenKey
string
instanceId
string
instanceId
string
alertUid
string
alertUid
string
title
string
title
string
imageUrl
string
imageUrl
string
state
string
state
string
externalLink
string
externalLink
string
channelId
string
channelId
string
check
boolean
check
boolean
conditions
array
conditions
array
import { Novu, ProvidersIdEnum } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
const updatePayload = {
name: "SendGrid",
identifier: "sendgrid-identifier",
credentials: {
apiKey: "SUPER_SECRET_API_KEY",
from: "no-reply@novu.co",
senderName: "Novu Team"
// ... other credentials as per provider
},
active: true,
check: false
}
await novu.integrations.getWebhookProviderStatus(ProvidersIdEnum.SendGrid, updatePayload);
{
"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
requiredBody
application/json
name
string
identifier
string
_environmentId
string
active
boolean
If the integration is active the validation on the credentials field will run
credentials
object
credentials.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
check
boolean
conditions
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
Response
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.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, ProvidersIdEnum } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
const updatePayload = {
name: "SendGrid",
identifier: "sendgrid-identifier",
credentials: {
apiKey: "SUPER_SECRET_API_KEY",
from: "no-reply@novu.co",
senderName: "Novu Team"
// ... other credentials as per provider
},
active: true,
check: false
}
await novu.integrations.getWebhookProviderStatus(ProvidersIdEnum.SendGrid, updatePayload);
{
"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
}
}