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

Authorization

Authorization<token>

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

In: header

Header Parameters

idempotency-keystring

A header for idempotency purposes

curl -X GET "https://api.novu.co/v1/integrations/active" \
  -H "idempotency-key: <string>" \
  -H "Authorization: <token>"

The list of active integrations belonging to the organization that are successfully returned.

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

Header Parameters

Response

TypeScript