Novu · Schema
CreateIntegrationRequestDto
JSON Schema for Novu CreateIntegrationRequestDto.
NotificationsMessagingIn AppEmailSMSPushChatWorkflowsOpen SourceSubscribersTopicsInboxWorkflow OrchestrationMulti ChannelDigestMCPFrameworkReact
Properties
| Name | Type | Description |
|---|---|---|
| name | string | The name of the integration |
| identifier | string | The unique identifier for the integration |
| _environmentId | string | The ID of the associated environment |
| providerId | string | The provider ID for the integration |
| channel | string | The channel type for the integration. Not required for agent-kind integrations. |
| kind | string | Distinguishes delivery integrations from agent-runtime integrations. Defaults to "delivery". Agent integrations do not require a channel. |
| credentials | object | The credentials for the integration |
| active | boolean | If the integration is active, the validation on the credentials field will run |
| check | boolean | Flag to check the integration status |
| conditions | array | Conditions for the integration |
| configurations | object | Configurations for the integration |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/novu/main/json-schema/novu-create-integration-request-dto-schema.json",
"title": "CreateIntegrationRequestDto",
"description": "JSON Schema for Novu CreateIntegrationRequestDto.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the integration"
},
"identifier": {
"type": "string",
"description": "The unique identifier for the integration"
},
"_environmentId": {
"type": "string",
"description": "The ID of the associated environment",
"format": "uuid"
},
"providerId": {
"type": "string",
"description": "The provider ID for the integration"
},
"channel": {
"enum": [
"in_app",
"email",
"sms",
"chat",
"push"
],
"type": "string",
"description": "The channel type for the integration. Not required for agent-kind integrations."
},
"kind": {
"enum": [
"delivery",
"agent"
],
"type": "string",
"description": "Distinguishes delivery integrations from agent-runtime integrations. Defaults to \"delivery\". Agent integrations do not require a channel."
},
"credentials": {
"description": "The credentials for the integration",
"allOf": [
{
"type": "object",
"properties": {
"apiKey": {
"type": "string"
},
"user": {
"type": "string"
},
"secretKey": {
"type": "string"
},
"domain": {
"type": "string"
},
"password": {
"type": "string"
},
"host": {
"type": "string"
},
"port": {
"type": "string"
},
"secure": {
"type": "boolean"
},
"region": {
"type": "string"
},
"accountSid": {
"type": "string"
},
"messageProfileId": {
"type": "string"
},
"token": {
"type": "string"
},
"from": {
"type": "string"
},
"senderName": {
"type": "string"
},
"projectName": {
"type": "string"
},
"applicationId": {
"type": "string"
},
"clientId": {
"type": "string"
},
"requireTls": {
"type": "boolean"
},
"ignoreTls": {
"type": "boolean"
},
"tlsOptions": {
"type": "object"
},
"baseUrl": {
"type": "string"
},
"webhookUrl": {
"type": "string"
},
"redirectUrl": {
"type": "string"
},
"hmac": {
"type": "boolean"
},
"serviceAccount": {
"type": "string"
},
"ipPoolName": {
"type": "string"
},
"apiKeyRequestHeader": {
"type": "string"
},
"secretKeyRequestHeader": {
"type": "string"
},
"idPath": {
"type": "string"
},
"datePath": {
"type": "string"
},
"apiToken": {
"type": "string"
},
"authenticateByToken": {
"type": "boolean"
},
"authenticationTokenKey": {
"type": "string"
},
"instanceId": {
"type": "string"
},
"alertUid": {
"type": "string"
},
"title": {
"type": "string"
},
"imageUrl": {
"type": "string"
},
"state": {
"type": "string"
},
"externalLink": {
"type": "string"
},
"channelId": {
"type": "string"
},
"phoneNumberIdentification": {
"type": "string"
},
"accessKey": {
"type": "string"
},
"appSid": {
"type": "string"
},
"senderId": {
"type": "string"
},
"tenantId": {
"type": "string"
},
"AppIOBaseUrl": {
"type": "string"
},
"signingSecret": {
"type": "string"
},
"outboundIntegrationId": {
"type": "string"
},
"useFromAddressOverride": {
"type": "boolean"
},
"fromAddressOverride": {
"type": "string"
},
"emailSlugPrefix": {
"type": "string",
"description": "Agent default shared inbox slug prefix used in `{emailSlugPrefix}-{agentId}@<shared-domain>`. Only meaningful on the NovuAgent email integration."
},
"externalEnvironmentId": {
"type": "string",
"description": "Claude Managed Agents: ID of the Anthropic environment tied to this integration. Hydrated by the API at integration provisioning time."
},
"externalWorkspaceId": {
"type": "string",
"description": "Claude Managed Agents: id of the Anthropic workspace used in console deep links. Defaults to `'default'` (the Default Workspace). Set this when the API key is scoped to a custom workspace (e.g. `wrkspc_\u2026`)."
}
}
}
]
},
"active": {
"type": "boolean",
"description": "If the integration is active, the validation on the credentials field will run"
},
"check": {
"type": "boolean",
"description": "Flag to check the integration status"
},
"conditions": {
"description": "Conditions for the integration",
"type": "array",
"items": {
"type": "object",
"properties": {
"isNegated": {
"type": "boolean"
},
"type": {
"type": "string",
"enum": [
"BOOLEAN",
"TEXT",
"DATE",
"NUMBER",
"STATEMENT",
"LIST",
"MULTI_LIST",
"GROUP"
]
},
"value": {
"type": "string",
"enum": [
"AND",
"OR"
]
},
"children": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"value": {
"type": "string"
},
"operator": {
"type": "string",
"enum": [
"LARGER",
"SMALLER",
"LARGER_EQUAL",
"SMALLER_EQUAL",
"EQUAL",
"NOT_EQUAL",
"ALL_IN",
"ANY_IN",
"NOT_IN",
"BETWEEN",
"NOT_BETWEEN",
"LIKE",
"NOT_LIKE",
"IN"
]
},
"on": {
"type": "string",
"enum": [
"subscriber",
"payload"
]
}
},
"required": [
"field",
"value",
"operator",
"on"
]
}
}
},
"required": [
"isNegated",
"type",
"value",
"children"
]
}
},
"configurations": {
"type": "object",
"description": "Configurations for the integration"
}
}
}