AgentIntegrationResponseIntegrationDto

August 7, 2026 ยท View on GitHub

Fields

FieldTypeRequiredDescription
idString:heavy_check_mark:Integration document _id.
identifierString:heavy_check_mark:The integration identifier (matches the integration store), not the internal MongoDB _id.
nameString:heavy_check_mark:N/A
providerIdString:heavy_check_mark:N/A
channelOptional<ChannelTypeEnum>:heavy_minus_sign:Channel type through which the message is sent
activeboolean:heavy_check_mark:N/A
sharedInboundAddressOptional<String>:heavy_minus_sign:The Novu shared inbox address for this agent. Set whenever the cloud shared-inbox feature is enabled. The dashboard uses this as the headline inbound address and to render the shared inbox row in the inbox list.
defaultSenderNameOptional<String>:heavy_minus_sign:Default email From display name for this agent (NovuAgent integrations only). Falls back to the agent name when not explicitly stored on the integration credentials.
sharedInboxDisabledOptional<Boolean>:heavy_minus_sign:When true, the worker drops inbound mail addressed to this agent on the shared agentconnect.sh domain. Custom-domain routes still deliver. Meaningful on cloud-enabled NovuAgent integrations; on self-hosted it is set defensively at provisioning time and is effectively redundant.