Como enviar dados adicionais pelo SDK do widget

Use este guia quando você precisa enviar dados adicionais do usuário pelo SDK do widget da IAra.

Observação técnica importante

Por compatibilidade com a base herdada, o SDK pode expor objetos com nomes como window.$chatwoot, window.chatwootSettings e window.chatwootSDK. Use esses nomes exatamente como aparecem no código, a menos que a Digi2B informe um alias específico para sua instalação.

Detectar quando o SDK carregou

window.addEventListener('chatwoot:ready', function () {
  // Use window.$chatwoot aqui
});

Para ouvir mensagens recebidas no widget:

window.addEventListener('chatwoot:on-message', function (event) {
  console.log('chatwoot:on-message', event.detail);
});

Configurações do widget

window.chatwootSettings = {
  hideMessageBubble: false,
  showUnreadMessagesDialog: false,
  position: 'left',
  locale: 'pt_BR',
  useBrowserLanguage: false,
  type: 'standard',
  darkMode: 'auto',
  // baseDomain: 'seudominio.com'
};

Abrir, fechar e alternar o widget

window.$chatwoot.toggle();
window.$chatwoot.toggle('open');
window.$chatwoot.toggle('close');

Para mostrar ou ocultar o balão:

window.$chatwoot.toggleBubbleVisibility('show');
window.$chatwoot.toggleBubbleVisibility('hide');

Identificar usuário

window.$chatwoot.setUser('cliente-123', {
  email: '[email protected]',
  name: 'Maria Souza',
  avatar_url: 'https://seudominio.com/avatar/maria.png',
  phone_number: '+5511999999999',
});

Se sua conta usa validação de identidade, envie também identifier_hash:

window.$chatwoot.setUser('cliente-123', {
  name: 'Maria Souza',
  email: '[email protected]',
  identifier_hash: 'HASH_GERADO_NO_BACKEND',
});

Atributos personalizados

window.$chatwoot.setCustomAttributes({
  accountId: 123,
  pricingPlan: 'premium',
  lastPurchaseDate: '2026-06-01',
});

Para remover um atributo:

window.$chatwoot.deleteCustomAttribute('pricingPlan');

Etiquetas na conversa

window.$chatwoot.setLabel('lead-qualificado');
window.$chatwoot.removeLabel('lead-qualificado');

Redefinir sessão no logout

Quando o usuário sair do seu sistema, limpe a sessão do widget para evitar histórico indevido:

window.$chatwoot.reset();