CredentialsDto

Fields

Field	Type	Required	Description
apiKey	Optional<String>	:heavy_minus_sign:	N/A
user	Optional<String>	:heavy_minus_sign:	N/A
secretKey	Optional<String>	:heavy_minus_sign:	N/A
domain	Optional<String>	:heavy_minus_sign:	N/A
password	Optional<String>	:heavy_minus_sign:	N/A
host	Optional<String>	:heavy_minus_sign:	N/A
port	Optional<String>	:heavy_minus_sign:	N/A
secure	Optional<Boolean>	:heavy_minus_sign:	N/A
region	Optional<String>	:heavy_minus_sign:	N/A
accountSid	Optional<String>	:heavy_minus_sign:	N/A
messageProfileId	Optional<String>	:heavy_minus_sign:	N/A
token	Optional<String>	:heavy_minus_sign:	N/A
from	Optional<String>	:heavy_minus_sign:	N/A
senderName	Optional<String>	:heavy_minus_sign:	N/A
projectName	Optional<String>	:heavy_minus_sign:	N/A
applicationId	Optional<String>	:heavy_minus_sign:	N/A
clientId	Optional<String>	:heavy_minus_sign:	N/A
requireTls	Optional<Boolean>	:heavy_minus_sign:	N/A
ignoreTls	Optional<Boolean>	:heavy_minus_sign:	N/A
tlsOptions	Optional<TlsOptions>	:heavy_minus_sign:	N/A
baseUrl	Optional<String>	:heavy_minus_sign:	N/A
webhookUrl	Optional<String>	:heavy_minus_sign:	N/A
redirectUrl	Optional<String>	:heavy_minus_sign:	N/A
hmac	Optional<Boolean>	:heavy_minus_sign:	N/A
serviceAccount	Optional<String>	:heavy_minus_sign:	N/A
ipPoolName	Optional<String>	:heavy_minus_sign:	N/A
apiKeyRequestHeader	Optional<String>	:heavy_minus_sign:	N/A
secretKeyRequestHeader	Optional<String>	:heavy_minus_sign:	N/A
idPath	Optional<String>	:heavy_minus_sign:	N/A
datePath	Optional<String>	:heavy_minus_sign:	N/A
apiToken	Optional<String>	:heavy_minus_sign:	N/A
authenticateByToken	Optional<Boolean>	:heavy_minus_sign:	N/A
authenticationTokenKey	Optional<String>	:heavy_minus_sign:	N/A
instanceId	Optional<String>	:heavy_minus_sign:	N/A
alertUid	Optional<String>	:heavy_minus_sign:	N/A
title	Optional<String>	:heavy_minus_sign:	N/A
imageUrl	Optional<String>	:heavy_minus_sign:	N/A
state	Optional<String>	:heavy_minus_sign:	N/A
externalLink	Optional<String>	:heavy_minus_sign:	N/A
channelId	Optional<String>	:heavy_minus_sign:	N/A
phoneNumberIdentification	Optional<String>	:heavy_minus_sign:	N/A
accessKey	Optional<String>	:heavy_minus_sign:	N/A
appSid	Optional<String>	:heavy_minus_sign:	N/A
senderId	Optional<String>	:heavy_minus_sign:	N/A
tenantId	Optional<String>	:heavy_minus_sign:	N/A
appIOBaseUrl	Optional<String>	:heavy_minus_sign:	N/A
signingSecret	Optional<String>	:heavy_minus_sign:	N/A
outboundIntegrationId	Optional<String>	:heavy_minus_sign:	N/A
outboundConnectedAt	Optional<String>	:heavy_minus_sign:	N/A
whatsNextCompletedAt	Optional<String>	:heavy_minus_sign:	ISO timestamp marking Layer-2 What's next completion (Connected badge + guide hide). WhatsApp Business: stamped on post-connect Access Token rotation or manual confirm.
useFromAddressOverride	Optional<Boolean>	:heavy_minus_sign:	N/A
fromAddressOverride	Optional<String>	:heavy_minus_sign:	N/A
emailSlugPrefix	Optional<String>	:heavy_minus_sign:	Agent default shared inbox slug prefix used in {emailSlugPrefix}-{agentId}@<shared-domain>. Only meaningful on the NovuAgent email integration.
externalEnvironmentId	Optional<String>	:heavy_minus_sign:	Claude Managed Agents: ID of the Anthropic environment tied to this integration. Hydrated by the API at integration provisioning time.
externalVaultId	Optional<String>	:heavy_minus_sign:	Claude Managed Agents: ID of the Anthropic vault (vlt_…) tied to this integration. Hydrated by the API at integration provisioning time and used to push OAuth-completed MCP credentials to the per-vault credentials API.
externalWorkspaceId	Optional<String>	:heavy_minus_sign:	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_…).