Adapte clientes de chat ao novo formato do Chat Trigger
Antes de começar
Deixar o chat incorporado ou o cliente próprio pronto para as mensagens em JSON que o Chat Trigger envia no n8n 3.0.
- Workflow com Chat Trigger no modo de resposta Using Response Nodes.
- Acesso ao código da página ou do aplicativo que mostra o chat.
- Instância de testes com cópia da sua instância.
No n8n 3.0, o WebSocket usado pelo Chat Trigger no modo de resposta Using Response Nodes envia toda mensagem como um objeto JSON com o campo type. Antes, as mensagens de controle e as respostas em texto chegavam como texto puro. Uma resposta do Chat node agora chega como { "type": "message", "text": "..." }. Um cliente que mostrava o texto recebido sem tratamento exibe o JSON inteiro na tela.
Quais chats precisam de ajuste
| Como o chat aparece | O que fazer |
|---|---|
| Hosted Chat, servido pelo n8n | Nada. O n8n carrega um widget atualizado nessa página |
Embedded Chat com o widget @n8n/chat |
Atualize o widget para a versão 1.31.0 ou mais nova antes de atualizar o n8n |
| Embedded Chat com cliente próprio ligado direto ao WebSocket | Leia cada mensagem como JSON e trate pelo campo type |
Workflows com o Chat Trigger nos outros modos de resposta não usam esse WebSocket e não mudam.
Os tipos de mensagem
O campo type traz um destes valores: heartbeat, continue, error, message ou with-buttons. O texto de uma resposta comum vem no campo text do tipo message.
O cliente responde a cada heartbeat com { "type": "heartbeat-ack" }. O n8n ignora mensagens recebidas que não sejam JSON. Um cliente que confirmava o heartbeat em texto puro precisa mandar a confirmação em JSON.
Procedimento
- Abra a página ou o aplicativo que mostra o chat e descubra se ele usa o
@n8n/chatou um cliente próprio. - Com o
@n8n/chat, troque a versão nopackage.jsonou na tag do script para 1.31.0 ou mais nova e publique a página. O widget entende os dois formatos a partir dessa versão, por isso a troca pode ser feita ainda na 2.x. - Com cliente próprio, ajuste o tratamento das mensagens recebidas, como no exemplo abaixo.
- Na instância de testes atualizada para a 3.x, faça uma conversa completa e confira as respostas, os botões e as mensagens de erro.
socket.addEventListener('message', (evento) => { let mensagem; try { mensagem = JSON.parse(evento.data); } catch { return; }
switch (mensagem.type) { case 'heartbeat': socket.send(JSON.stringify({ type: 'heartbeat-ack' })); break; case 'message': mostrarResposta(mensagem.text); break; default: tratarControle(mensagem); }});No exemplo, mostrarResposta e tratarControle são as funções do seu cliente que já mostravam a resposta e tratavam as mensagens de controle. Os tipos continue, error e with-buttons caem em tratarControle. Essa função precisa ler o objeto recebido, não mais o texto puro.
O que conferir depois
- Conexões longas. Deixe o chat aberto por alguns minutos sem enviar nada. Se a conexão cair, confira se o cliente está respondendo ao
heartbeatem JSON. - Respostas com botões. Se o Chat node envia opções para o usuário escolher, confira que elas aparecem como botões. Opções exibidas como texto indicam que o tipo
with-buttonsainda não foi tratado. - Versão fixada. Em páginas que carregam o widget por CDN com a versão no endereço, confira que a versão nova ficou gravada no endereço publicado.
Confira o resultado
Uma conversa completa na instância de testes mostra as respostas do Chat node como texto, sem JSON aparecendo na tela, e a conexão continua aberta entre as mensagens.
