API Reference
- API Overview
- API Rate Limiting
- Events
- Subscribers
- Topics
- Notification
- Workflows
- Workflow overrides
- Workflow groups
- Integrations
- Layouts
- Environments
- Changes
- Execution details
- Feeds
- Tenants
- Organizations
- Messages
Integrations
Update integration
PUT
/
v1
/
integrations
/
{integrationId}
Copy
import { Novu, ProvidersIdEnum } from "@novu/node";
const novu = new Novu("<NOVU_SECRET_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
);
Copy
{
"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
Copy
import { Novu, ProvidersIdEnum } from "@novu/node";
const novu = new Novu("<NOVU_SECRET_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
);
Copy
{
"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
Body
application/json
Response
200
application/json
OK
The response is of type object
.
Was this page helpful?
Copy
import { Novu, ProvidersIdEnum } from "@novu/node";
const novu = new Novu("<NOVU_SECRET_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
);
Copy
{
"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
}
}
Assistant
Responses are generated using AI and may contain mistakes.