🇺🇸English
🇪🇸Español
🇧🇷Português

docs.configuration.title

docs.configuration.intro

docs.configuration.mainConfig

docs.configuration.mainConfigDesc

docs.configuration.optiondocs.configuration.typedocs.configuration.defaultdocs.configuration.description
apiKey *string-Your unique API key provided by Chask
organizationId *string-Your organization identifier
apiUrlstring'https://api.chask.io'Base URL for the Chask API
wsUrlstring'wss://ws.chask.io/widget'WebSocket URL for real-time messaging
themeThemeConfigSee belowTheme customization options
userUserConfigundefinedUser information for identified sessions
optionsWidgetOptionsSee belowWidget behavior options
callbacksWidgetCallbacksundefinedEvent callback functions

* = Required field

docs.configuration.themeConfig

docs.configuration.themeConfigDesc

docs.configuration.optiondocs.configuration.typedocs.configuration.defaultdocs.configuration.description
primaryColorstring'#1C51A9'Primary brand color (hex or CSS color)
primaryTextColorstring'#FFFFFF'Text color on primary background
backgroundColorstring'#FFFFFF'Background color of the chat window
textColorstring'#0a1628'Text color in the chat window
borderRadiusstring'8px'Border radius for UI elements
positionstring'bottom-right'Widget position: 'bottom-right', 'bottom-left', 'top-right', 'top-left'
logoUrlstring''Company logo URL (displayed in chat header)
launcherIconUrlstring''Custom launcher button icon URL
launcherSizenumber60Launcher button size in pixels
titlestring''Widget title text (overrides locale default)
subtitlestring''Subtitle/tagline text (overrides locale default)
modestring'light'Theme mode: 'light', 'dark', or 'auto'
customCssstring''Custom CSS to inject into the widget

docs.configuration.userConfig

docs.configuration.userConfigDesc

docs.configuration.optiondocs.configuration.typedocs.configuration.description
idstringUnique user identifier in your system
namestringUser's display name
emailstringUser's email address
phonestringUser's phone number
avatarUrlstringUser's avatar URL
metadataobjectAdditional custom attributes (JSON object)

docs.configuration.optionsConfig

docs.configuration.optionsConfigDesc

docs.configuration.optiondocs.configuration.typedocs.configuration.defaultdocs.configuration.description
autoOpenbooleanfalseAuto-open the chat on page load
showLauncherbooleantrueShow the floating launcher button
soundEnabledbooleantrueEnable sound notifications
notificationsEnabledbooleantrueEnable desktop notifications
attachmentsEnabledbooleantrueEnable file attachments
localestring'es'Widget locale: 'es', 'en', 'pt', or 'auto'
zIndexnumber9999Z-index for the widget
agentNamestring'Asistente IA'Agent/assistant display name shown in chat messages
common.tip: common.playgroundTipConfig