Create integration

Create an integration for the current environment the user is based on the API key provided

POST/v1/integrations

Authorization

Authorization<token>

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

In: header

Request Body

application/jsonRequired

namestring

The name of the integration

identifierstring

The unique identifier for the integration

_environmentIdstring

The ID of the associated environment

Format: "uuid"

providerIdRequiredstring

The provider ID for the integration

channelRequiredstring

The channel type for the integration

Value in: "in_app" | "email" | "sms" | "chat" | "push"

credentialsobject

The credentials for the integration

activeboolean

If the integration is active, the validation on the credentials field will run

checkboolean

Flag to check the integration status

conditionsarray<object>

Conditions for the integration

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X POST "https://api.novu.co/v1/integrations" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "identifier": "string",
    "_environmentId": "4ddd0a4a-e7ba-4cb7-9228-83cb6c8a2123",
    "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",
      "channelId": "string",
      "phoneNumberIdentification": "string",
      "accessKey": "string"
    },
    "active": true,
    "check": true,
    "conditions": [
      {
        "isNegated": true,
        "type": "BOOLEAN",
        "value": "AND",
        "children": [
          {
            "field": "string",
            "value": "string",
            "operator": "LARGER",
            "on": "subscriber"
          }
        ]
      }
    ]
  }'

Created

{
  "_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",
    "channelId": "string",
    "phoneNumberIdentification": "string",
    "accessKey": "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"
        }
      ]
    }
  ]
}

Authorization

Request Body

Header Parameters

Response

TypeScript