docs.configuration.title
docs.configuration.intro
docs.configuration.mainConfig
docs.configuration.mainConfigDesc
| docs.configuration.option | docs.configuration.type | docs.configuration.default | docs.configuration.description |
|---|---|---|---|
apiKey * | string | - | Your unique API key provided by Chask |
organizationId * | string | - | Your organization identifier |
apiUrl | string | 'https://api.chask.io' | Base URL for the Chask API |
wsUrl | string | 'wss://ws.chask.io/widget' | WebSocket URL for real-time messaging |
theme | ThemeConfig | See below | Theme customization options |
user | UserConfig | undefined | User information for identified sessions |
options | WidgetOptions | See below | Widget behavior options |
callbacks | WidgetCallbacks | undefined | Event callback functions |
* = Required field
docs.configuration.themeConfig
docs.configuration.themeConfigDesc
| docs.configuration.option | docs.configuration.type | docs.configuration.default | docs.configuration.description |
|---|---|---|---|
primaryColor | string | '#1C51A9' | Primary brand color (hex or CSS color) |
primaryTextColor | string | '#FFFFFF' | Text color on primary background |
backgroundColor | string | '#FFFFFF' | Background color of the chat window |
textColor | string | '#0a1628' | Text color in the chat window |
borderRadius | string | '8px' | Border radius for UI elements |
position | string | 'bottom-right' | Widget position: 'bottom-right', 'bottom-left', 'top-right', 'top-left' |
logoUrl | string | '' | Company logo URL (displayed in chat header) |
launcherIconUrl | string | '' | Custom launcher button icon URL |
launcherSize | number | 60 | Launcher button size in pixels |
title | string | '' | Widget title text (overrides locale default) |
subtitle | string | '' | Subtitle/tagline text (overrides locale default) |
mode | string | 'light' | Theme mode: 'light', 'dark', or 'auto' |
customCss | string | '' | Custom CSS to inject into the widget |
docs.configuration.userConfig
docs.configuration.userConfigDesc
| docs.configuration.option | docs.configuration.type | docs.configuration.description |
|---|---|---|
id | string | Unique user identifier in your system |
name | string | User's display name |
email | string | User's email address |
phone | string | User's phone number |
avatarUrl | string | User's avatar URL |
metadata | object | Additional custom attributes (JSON object) |
docs.configuration.optionsConfig
docs.configuration.optionsConfigDesc
| docs.configuration.option | docs.configuration.type | docs.configuration.default | docs.configuration.description |
|---|---|---|---|
autoOpen | boolean | false | Auto-open the chat on page load |
showLauncher | boolean | true | Show the floating launcher button |
soundEnabled | boolean | true | Enable sound notifications |
notificationsEnabled | boolean | true | Enable desktop notifications |
attachmentsEnabled | boolean | true | Enable file attachments |
locale | string | 'es' | Widget locale: 'es', 'en', 'pt', or 'auto' |
zIndex | number | 9999 | Z-index for the widget |
agentName | string | 'Asistente IA' | Agent/assistant display name shown in chat messages |
common.tip: common.playgroundTipConfig