API Reference
Notifications
Integrations
Subscribers
- GETGet subscribers
- POSTBulk create subscribers
- PUTUpdate subscriber credentials
- PATCHModify subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber messages as seen, read, unseen or unread
- 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
- GETSearch for subscribers
- POSTCreate subscriber
- GETGet subscriber
- DELDelete subscriber
- PATCHPatch subscriber
- GETGet subscriber preferences
- PATCHUpdate subscriber global or workflow specific preferences
Integrations
Get active integrations
Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
GET
/
v1
/
integrations
/
active
Copy
curl --request GET \
--url https://api.novu.co/v1/integrations/active
Copy
[
{
"_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>",
"apiKeyRequestHeader": "<string>",
"secretKeyRequestHeader": "<string>",
"idPath": "<string>",
"datePath": "<string>",
"apiToken": "<string>",
"authenticateByToken": true,
"authenticationTokenKey": "<string>",
"instanceId": "<string>",
"alertUid": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"state": "<string>",
"externalLink": "<string>"
},
"active": true,
"deleted": true,
"deletedAt": "<string>",
"deletedBy": "<string>",
"primary": true,
"conditions": [
{
"isNegated": true,
"type": "BOOLEAN",
"value": "AND",
"children": [
{
"field": "<string>",
"value": "<string>",
"operator": "LARGER",
"on": "subscriber"
}
]
}
]
}
]
Response
200
application/json
The list of active integrations belonging to the organization that are successfully returned.
The response is of type object[]
.
Was this page helpful?
Copy
curl --request GET \
--url https://api.novu.co/v1/integrations/active
Copy
[
{
"_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>",
"apiKeyRequestHeader": "<string>",
"secretKeyRequestHeader": "<string>",
"idPath": "<string>",
"datePath": "<string>",
"apiToken": "<string>",
"authenticateByToken": true,
"authenticationTokenKey": "<string>",
"instanceId": "<string>",
"alertUid": "<string>",
"title": "<string>",
"imageUrl": "<string>",
"state": "<string>",
"externalLink": "<string>"
},
"active": true,
"deleted": true,
"deletedAt": "<string>",
"deletedBy": "<string>",
"primary": true,
"conditions": [
{
"isNegated": true,
"type": "BOOLEAN",
"value": "AND",
"children": [
{
"field": "<string>",
"value": "<string>",
"operator": "LARGER",
"on": "subscriber"
}
]
}
]
}
]
Assistant
Responses are generated using AI and may contain mistakes.