Novu Integration Response Dto Structure

{
  "$schema": "https://json-structure.org/v0.1/schema",
  "name": "IntegrationResponseDto",
  "description": "JSON Schema for Novu IntegrationResponseDto.",
  "sourceFormat": "OpenAPI 3.x components.schemas",
  "fields": [
    {
      "name": "_id",
      "type": "string",
      "description": "The unique identifier of the integration record in the database. This is automatically generated.",
      "required": false
    },
    {
      "name": "_environmentId",
      "type": "string",
      "description": "The unique identifier for the environment associated with this integration. This links to the Environment collection.",
      "required": true
    },
    {
      "name": "_organizationId",
      "type": "string",
      "description": "The unique identifier for the organization that owns this integration. This links to the Organization collection.",
      "required": true
    },
    {
      "name": "name",
      "type": "string",
      "description": "The name of the integration, which is used to identify it in the user interface.",
      "required": true
    },
    {
      "name": "identifier",
      "type": "string",
      "description": "A unique string identifier for the integration, often used for API calls or internal references.",
      "required": true
    },
    {
      "name": "providerId",
      "type": "string",
      "description": "The identifier for the provider of the integration (e.g., \"mailgun\", \"twilio\").",
      "required": true
    },
    {
      "name": "channel",
      "type": "string",
      "description": "The channel type for the integration, which defines how it communicates (e.g., email, SMS). Not set for agent-kind integrations.",
      "required": false
    },
    {
      "name": "kind",
      "type": "string",
      "description": "Distinguishes delivery integrations from agent-runtime integrations. Defaults to \"delivery\". Agent integrations do not have a channel.",
      "required": false
    },
    {
      "name": "credentials",
      "type": "object",
      "description": "The decrypted credentials required for the integration to function (e.g. provider API keys, signing secrets). Only returned to dashboard/session-token callers; API-key authenticated callers receive th",
      "required": false
    },
    {
      "name": "configurations",
      "type": "object",
      "description": "The configurations required for enabling the additional configurations of the integration.",
      "required": false
    },
    {
      "name": "active",
      "type": "boolean",
      "description": "Indicates whether the integration is currently active. An active integration will process events and messages.",
      "required": true
    },
    {
      "name": "deleted",
      "type": "boolean",
      "description": "Indicates whether the integration has been marked as deleted (soft delete).",
      "required": true
    },
    {
      "name": "deletedAt",
      "type": "string",
      "description": "The timestamp indicating when the integration was deleted. This is set when the integration is soft deleted.",
      "required": false
    },
    {
      "name": "deletedBy",
      "type": "string",
      "description": "The identifier of the user who performed the deletion of this integration. Useful for audit trails.",
      "required": false
    },
    {
      "name": "primary",
      "type": "boolean",
      "description": "Indicates whether this integration is marked as primary. A primary integration is often the default choice for processing.",
      "required": true
    },
    {
      "name": "conditions",
      "type": "array",
      "description": "An array of conditions associated with the integration that may influence its behavior or processing logic.",
      "required": false
    }
  ]
}