Parâmetros de Configuração

Todos os parâmetros são definidos no objeto window.taubotConfig antes do carregamento do widget.

Obrigatórios

`appId` — `string` obrigatório

Identificador único do seu assistente, fornecido pela TAU. Use o mesmo appId tanto no widget visual quanto no modo invisível de rastreio.

appId: 'meusite.com.br'

`company_domain` — `string` avançado

Alias avançado para identificar o domínio em instalações legadas ou casos orientados pela equipe TAU. Para novas instalações públicas, prefira appId.

company_domain: 'meusite.com.br'

Para evitar confusão, use appId como identificador principal. No modo invisível de rastreio, combine appId com widgetMode: 'tracking_only'.

Aparência do botão

`chatbotButtonBackground` — `string`

Cor de fundo do botão. Aceita qualquer valor CSS válido.

chatbotButtonBackground: '#4834D4' // Padrão: '#009588'

`chatbotButtonForeground` — `string`

Cor do ícone/texto do botão.

chatbotButtonForeground: '#FFFFFF' // Padrão: '#FFFFFF'

`chatbotButtonSize` — `number`

Tamanho do botão em pixels.

chatbotButtonSize: 60 // Padrão: 62

`showChatbotButton` — `boolean`

Exibe ou oculta o botão do chat.

showChatbotButton: true // Padrão: true

`chatbotButtonOpenStateSVG` / `chatbotButtonClosedStateSVG` — `string`

Código SVG customizado para o ícone do botão nos estados aberto e fechado.

chatbotButtonClosedStateSVG: '<svg>...</svg>'

Posicionamento

`chatbotButtonBottom` — `number`

Distância em pixels da borda inferior da tela.

chatbotButtonBottom: 20 // Padrão: 20

`chatbotButtonRight` — `number`

Distância em pixels da borda direita da tela.

chatbotButtonRight: 20 // Padrão: 20

`chatbotSpaceFromButton` — `number`

Espaço em pixels entre o botão e a janela do chat.

chatbotSpaceFromButton: 72 // Padrão: 72

Dimensões da janela

`chatWidth` — `number`

Largura em pixels (modo default).

chatWidth: 400 // Padrão: 400

`chatWidthCool` — `number`

Largura em pixels (modo cool).

chatWidthCool: 700 // Padrão: 700

`maxChatHeight` — `number`

Altura máxima da janela em pixels.

maxChatHeight: 700 // Padrão: 700

`percentChatHeight` — `number`

Porcentagem da altura da tela que o chat ocupa.

percentChatHeight: 80 // Padrão: 80

`mobileWidthThreshold` — `number`

Largura em pixels que define quando usar layout mobile.

mobileWidthThreshold: 500 // Padrão: 500

Comportamento

`mode` — `string`

Modo de exibição. Opções: 'default' ou 'cool'.

mode: 'cool' // Padrão: 'default'

	Modo `default`	Modo `cool`
Posição	Próximo ao botão	Centralizado na tela
Largura	400px (`chatWidth`)	700px (`chatWidthCool`)
Overlay	Sem overlay	Overlay escuro
Estilo	Discreto, corporativo	Moderno, chamativo

`widgetMode` — `string`

Define se o widget deve aparecer visualmente ou funcionar apenas como rastreio de campanhas. Use 'tracking_only' para carregar o rastreio sem mostrar botão ou janela de chat.

widgetMode: 'tracking_only'

Esse modo é útil em páginas de campanha, landing pages e sites onde o atendimento acontece pelo WhatsApp, mas você ainda quer medir a origem dos cliques.

`defaultRoute` — `string`

Rota inicial do chat. Opções: 'home' ou 'chat'.

defaultRoute: 'chat' // Padrão: 'home'

`defaultMessage` — `string`

Mensagem pré-preenchida na caixa de entrada.

defaultMessage: 'Olá! Preciso de ajuda.'

`autoOpen` — `boolean`

Abre o chat automaticamente ao carregar a página.

autoOpen: true // Padrão: false

`alwaysOpenOnMobile` — `boolean`

Força abertura automática em dispositivos móveis.

alwaysOpenOnMobile: true // Padrão: false

`closeChatOnOutsideClick` — `boolean`

Fecha o chat ao clicar fora da janela.

closeChatOnOutsideClick: true // Padrão: false

Integração WhatsApp

`enableWhatsApp` — `boolean`

Ativa o modo WhatsApp (redireciona para o WhatsApp ao invés de abrir o chat).

enableWhatsApp: true // Padrão: false

`whatsAppNumber` — `string`

Número no formato internacional.

whatsAppNumber: '+5511999999999'

`whatsAppMessage` — `string`

Mensagem pré-preenchida ao abrir o WhatsApp.

whatsAppMessage: 'Olá! Vim do site e preciso de ajuda.'

Ativa a coleta de origem de campanhas pelo snippet único do widget. Quando enabled está ativo, a TAU identifica dados como campanha, origem, canal e cliques para WhatsApp quando essas informações estão disponíveis na visita.

attribution: {
  enabled: true
}

Você também pode combinar com o modo invisível:

window.taubotConfig = {
  appId: 'meusite.com.br',
  widgetMode: 'tracking_only',
  attribution: { enabled: true }
};

`heartbeatUrl` — `string` avançado

Endereço usado para registrar cliques acompanhados. Em produção, a TAU já usa o endereço oficial automaticamente. Configure apenas se a equipe TAU orientar um ambiente ou rota específica.

heartbeatUrl: 'URL_INFORMADA_PELA_TAU'

`whatsappSelectors` — `string[]` avançado

Lista de seletores usada quando o site tem botões de WhatsApp muito customizados. Por padrão, a TAU reconhece links comuns do WhatsApp (wa.me, api.whatsapp.com, web.whatsapp.com/send) e elementos marcados com data-taubot-wa.

whatsappSelectors: ['.meu-botao-whatsapp', '[data-whatsapp-cta]']

Na maioria dos sites, você não precisa configurar heartbeatUrl nem whatsappSelectors. O padrão de produção já cobre os links de WhatsApp mais usados.

Personalização visual avançada

`calloutBorder` / `calloutBackgroundColor` / `calloutFontColor` — `string`

Cores dos elementos callout/balão próximo ao botão.

calloutBorder: '#A8A8A8',
calloutBackgroundColor: '#FFFFFF',
calloutFontColor: '#333333'

Usuário logado

Veja a documentação completa em Área Logada.

user: {
  id: 'user123',
  hash: 'HMAC_GERADO_NO_SERVIDOR',
  name: 'João Silva',
  email: 'joao@example.com',
  phone: '+5511999999999',
  profile_picture_url: 'https://...',
  created_at: 1701967378
}

Parâmetros de Configuração

On this page