Integrations

Create an integration

Create an integration for the current environment the user is based on the API key provided. Each provider supports different credentials, check the provider documentation for more details. Only integration metadata is returned, credentials field is returned as an empty object.

post/v1/integrations

Request

  • Base URL: https://api.notifly.io
  • URL: https://api.notifly.io/v1/integrations
  • Auth: API key in header Authorization

Request body

namestring

The name of the integration

identifierstring

The unique identifier for the integration

_environmentIdstring uuid

The ID of the associated environment

providerIdstring

The provider ID for the integration

channel'in_app' | 'email' | 'sms' | 'chat' | 'push' | 'tool'

The channel type for the integration. Not required for agent-kind integrations.

kind'delivery' | 'agent'

Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not require a channel.

activeboolean

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

checkboolean

Flag to check the integration status

rulesobject nullable

JSONLogic used at send time to select this integration. Takes precedence over conditions.

configurationsobject

Configurations for the integration

Example request

{
  "rules": {
    "==": [
      {
        "var": "context.tenant.id"
      },
      "acme"
    ]
  }
}

Response

Created

Example response

{
  "data": {
    "rules": {
      "==": [
        {
          "var": "context.tenant.id"
        },
        "acme"
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.