Integrations

List active integrations

List all the active integrations created in the organization. Only integration metadata is returned, credentials field is returned as an empty object.

get/v1/integrations/active

Request

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

Response

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

_idstring

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

_environmentIdstring required

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

_organizationIdstring required

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

namestring required

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

identifierstring required

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

providerIdstring required

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

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

The channel type for the integration, which defines how it communicates (e.g., email, SMS). Not set for agent-kind integrations.

kind'delivery' | 'agent'

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

activeboolean required

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

deletedboolean required

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

deletedAtstring

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

deletedBystring

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

primaryboolean required

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

rulesobject nullable

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

Example response

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

Changes

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