Configuration Parameters
Complete reference for all parameters of the window.taubotConfig object.
Configuration Parameters
All parameters are defined in the window.taubotConfig object before the widget loads.
Required
appId — string required
Your assistant's unique identifier, provided by TAU. Use the same appId for both the visual widget and invisible tracking mode.
appId: 'mysite.com'company_domain — string advanced
Advanced alias for identifying the domain in legacy installations or cases guided by the TAU team. For new public installations, prefer appId.
company_domain: 'mysite.com'To avoid confusion, use appId as the main identifier. In invisible tracking mode, combine appId with widgetMode: 'tracking_only'.
Button appearance
chatbotButtonBackground — string
Button background color. Accepts any valid CSS value.
chatbotButtonBackground: '#4834D4' // Default: '#009588'chatbotButtonForeground — string
Button icon/text color.
chatbotButtonForeground: '#FFFFFF' // Default: '#FFFFFF'chatbotButtonSize — number
Button size in pixels.
chatbotButtonSize: 60 // Default: 62showChatbotButton — boolean
Shows or hides the chat button.
showChatbotButton: true // Default: truechatbotButtonOpenStateSVG / chatbotButtonClosedStateSVG — string
Custom SVG code for the button icon in open and closed states.
chatbotButtonClosedStateSVG: '<svg>...</svg>'Positioning
chatbotButtonBottom — number
Distance in pixels from the bottom edge of the screen.
chatbotButtonBottom: 20 // Default: 20chatbotButtonRight — number
Distance in pixels from the right edge of the screen.
chatbotButtonRight: 20 // Default: 20chatbotSpaceFromButton — number
Space in pixels between the button and the chat window.
chatbotSpaceFromButton: 72 // Default: 72Window dimensions
chatWidth — number
Width in pixels (default mode).
chatWidth: 400 // Default: 400chatWidthCool — number
Width in pixels (cool mode).
chatWidthCool: 700 // Default: 700maxChatHeight — number
Maximum window height in pixels.
maxChatHeight: 700 // Default: 700percentChatHeight — number
Percentage of screen height occupied by the chat.
percentChatHeight: 80 // Default: 80mobileWidthThreshold — number
Width in pixels that defines when to use the mobile layout.
mobileWidthThreshold: 500 // Default: 500Behavior
mode — string
Display mode. Options: 'default' or 'cool'.
mode: 'cool' // Default: 'default'default mode | cool mode | |
|---|---|---|
| Position | Near the button | Centered on screen |
| Width | 400px (chatWidth) | 700px (chatWidthCool) |
| Overlay | No overlay | Dark overlay |
| Style | Subtle, corporate | Modern, eye-catching |
widgetMode — string
Defines whether the widget appears visually or works only as campaign tracking. Use 'tracking_only' to load tracking without showing a button or chat window.
widgetMode: 'tracking_only'This mode is useful for campaign pages, landing pages, and websites where service happens through WhatsApp, but you still want to measure click sources.
defaultRoute — string
Initial chat route. Options: 'home' or 'chat'.
defaultRoute: 'chat' // Default: 'home'defaultMessage — string
Pre-filled message in the input box.
defaultMessage: 'Hi! I need help.'autoOpen — boolean
Opens the chat automatically when the page loads.
autoOpen: true // Default: falsealwaysOpenOnMobile — boolean
Forces automatic opening on mobile devices.
alwaysOpenOnMobile: true // Default: falsecloseChatOnOutsideClick — boolean
Closes the chat when clicking outside the window.
closeChatOnOutsideClick: true // Default: falseWhatsApp integration
enableWhatsApp — boolean
Enables WhatsApp mode (redirects to WhatsApp instead of opening the chat).
enableWhatsApp: true // Default: falsewhatsAppNumber — string
Phone number in international format.
whatsAppNumber: '+15551234567'whatsAppMessage — string
Pre-filled message when opening WhatsApp.
whatsAppMessage: 'Hi! I came from your website and need help.'Campaign tracking
attribution — object
Enables campaign source tracking through the single widget snippet. When enabled is active, TAU identifies details such as campaign, source, channel, and WhatsApp clicks when those details are available during the visit.
attribution: {
enabled: true
}You can also combine it with invisible mode:
window.taubotConfig = {
appId: 'mysite.com',
widgetMode: 'tracking_only',
attribution: { enabled: true }
};heartbeatUrl — string advanced
Address used to register tracked clicks. In production, TAU already uses the official address automatically. Configure it only if the TAU team provides a specific environment or route.
heartbeatUrl: 'URL_PROVIDED_BY_TAU'whatsappSelectors — string[] advanced
Selector list used when the website has highly customized WhatsApp buttons. By default, TAU recognizes common WhatsApp links (wa.me, api.whatsapp.com, web.whatsapp.com/send) and elements marked with data-taubot-wa.
whatsappSelectors: ['.my-whatsapp-button', '[data-whatsapp-cta]']On most websites, you do not need to configure heartbeatUrl or whatsappSelectors. The production defaults already cover the most common WhatsApp links.
Advanced visual customization
calloutBorder / calloutBackgroundColor / calloutFontColor — string
Colors for the callout/bubble element near the button.
calloutBorder: '#A8A8A8',
calloutBackgroundColor: '#FFFFFF',
calloutFontColor: '#333333'Authenticated user
See the full documentation at Authenticated Area.
user: {
id: 'user123',
hash: 'SERVER_GENERATED_HMAC',
name: 'John Smith',
email: 'john@example.com',
phone: '+15551234567',
profile_picture_url: 'https://...',
created_at: 1701967378
}