Update integration

PUT

integrations

{integrationId}

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
);

{
  "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

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
);

{
  "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

Authorization

string

headerrequired

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

integrationId

string

required

Body

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

removeNovuBranding

boolean

If true, the Novu branding will be removed from the Inbox component

check

boolean

conditions

object[]

Response

200 - application/json

data

object

data._id

string

The unique identifier of the integration record in the database. This is automatically generated.

data._environmentId

string

required

The unique identifier for the environment associated with this integration. This links to the Environment collection.

data._organizationId

string

required

The unique identifier for the organization that owns this integration. This links to the Organization collection.

data.name

string

required

The name of the integration, which is used to identify it in the user interface.

data.identifier

string

required

A unique string identifier for the integration, often used for API calls or internal references.

data.providerId

string

required

The identifier for the provider of the integration (e.g., "mailgun", "twilio").

data.channel

enum<string>

required

The channel type for the integration, which defines how the integration communicates (e.g., email, SMS).

Available options:

in_app,

email,

sms,

chat,

push

data.credentials

object

required

The credentials required for the integration to function, including API keys and other sensitive information.

data.active

boolean

required

Indicates whether the integration is currently active. An active integration will process events and messages.

data.deleted

boolean

required

Indicates whether the integration has been marked as deleted (soft delete).

data.deletedAt

string

The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.

data.deletedBy

string

The identifier of the user who performed the deletion of this integration. Useful for audit trails.

data.primary

boolean

required

Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.

data.conditions

object[]

An array of conditions associated with the integration that may influence its behavior or processing logic.

Was this page helpful?

Get webhook support status for provider Delete integration

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
);

{
  "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
  }
}