{
"$schema": "https://json-structure.org/v0.1/schema",
"name": "CreateIntegrationRequestDto",
"description": "JSON Schema for Novu CreateIntegrationRequestDto.",
"sourceFormat": "OpenAPI 3.x components.schemas",
"fields": [
{
"name": "name",
"type": "string",
"description": "The name of the integration",
"required": false
},
{
"name": "identifier",
"type": "string",
"description": "The unique identifier for the integration",
"required": false
},
{
"name": "_environmentId",
"type": "string",
"description": "The ID of the associated environment",
"required": false
},
{
"name": "providerId",
"type": "string",
"description": "The provider ID for the integration",
"required": false
},
{
"name": "channel",
"type": "string",
"description": "The channel type for the integration. Not required 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 require a channel.",
"required": false
},
{
"name": "credentials",
"type": "object",
"description": "The credentials for the integration",
"required": false
},
{
"name": "active",
"type": "boolean",
"description": "If the integration is active, the validation on the credentials field will run",
"required": false
},
{
"name": "check",
"type": "boolean",
"description": "Flag to check the integration status",
"required": false
},
{
"name": "conditions",
"type": "array",
"description": "Conditions for the integration",
"required": false
},
{
"name": "configurations",
"type": "object",
"description": "Configurations for the integration",
"required": false
}
]
}