Update integration

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Node.js

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: "[e-mail]",
    senderName: "Novu Team",
    // ... other credentials as per provider
  },
  active: true,
  check: false,
};

await novu.integrations.getWebhookProviderStatus(
  ProvidersIdEnum.SendGrid,
  updatePayload
);

Response

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

header

required

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

Show child attributes

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

credentials.phoneNumberIdentification

string

check

boolean

conditions

object[]

Show child attributes

conditions.isNegated

boolean

required

conditions.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

conditions.value

enum<string>

required

Available options:

AND,

OR

conditions.children

object[]

required

Show child attributes

conditions.children.field

string

required

conditions.children.value

string

required

conditions.children.operator

enum<string>

required

Available 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>

required

Available options:

subscriber,

payload

Response

200

application/json

Ok

_environmentId

string

required

_organizationId

string

required

name

string

required

identifier

string

required

providerId

string

required

channel

enum<string>

required

Available options:

in_app,

email,

sms,

chat,

push

credentials

object

required

Show child attributes

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

credentials.phoneNumberIdentification

string

active

boolean

required

deleted

boolean

required

deletedAt

string

required

deletedBy

string

required

primary

boolean

required

_id

string

conditions

object[]

Show child attributes

conditions.isNegated

boolean

required

conditions.type

enum<string>

required

Available options:

BOOLEAN,

TEXT,

DATE,

NUMBER,

STATEMENT,

LIST,

MULTI_LIST,

GROUP

conditions.value

enum<string>

required

Available options:

AND,

OR

conditions.children

object[]

required

Show child attributes

conditions.children.field

string

required

conditions.children.value

string

required

conditions.children.operator

enum<string>

required

Available 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>

required

Available options:

subscriber,

payload