Passar para o conteúdo principal

Tipos de eventos disponíveis: um guia detalhado

Atualizado há mais de 3 semanas

Resumo

Este artigo explica os diferentes tipos de eventos disponíveis para ações de API REST em Wati. Você aprenderá quando cada evento é acionado, quais dados ele pode enviar e como usá-los corretamente - especialmente ao coletar feedback, dados de formulário ou informações de lead.

Instruções

Ações de API REST baseadas em eventos são executadas automaticamente quando um evento específico ocorre em uma conversa. Cada tipo de evento se comporta de forma diferente, especialmente em termos de quais dados (parâmetros) podem ser enviados.

Entender essas diferenças ajuda a escolher o evento certo e evitar problemas de configuração.

1. Eventos de polegar para cima / polegar para baixo

Quando é acionado

Este evento é acionado quando um usuário clica no botão de feedback ( ou ) na interface de bate-papo.

Comportamento de parâmetro

  • Apenas parâmetros estáticos (fixos) são suportados

  • Dados de usuário dinâmicos não podem ser passados

Isso significa que todos os valores na solicitação da API devem ser pré-definidos.

Casos de uso comuns

  • Rastrear métricas de satisfação do usuário

  • Enviar notificações do Slack quando feedback negativo for recebido

  • Registre eventos de feedback em uma plataforma de análise

Importante: Eventos de polegar para cima e polegar para baixo não podem enviar informações de usuário dinâmicas, como endereços de e-mail, nomes ou conteúdo de conversa, por conta própria.

Combinação de polegar para cima/baixo com um formulário de feedback

Se você precisar de feedback detalhado ou informações de usuário, pode combinar esse evento com o evento Formulário enviado.

Como funciona

  1. Crie um formulário personalizado do tipo Feedback

  2. Quando o usuário clicar em ou , o formulário de feedback aparecerá automaticamente

  3. O usuário preencherá o formulário (por exemplo, motivo do feedback ou e-mail)

  4. Ambos os eventos podem ser acionados ao mesmo tempo:

    • Evento de polegar para cima/baixo → envia dados estáticos

    • Evento de formulário enviado → envia dados de formulário dinâmicos

Cenário de exemplo

Dica: Para coletar e-mails, motivos ou comentários, sempre use um formulário personalizado e crie uma ação de API REST separada para o evento Formulário enviado.

2. Evento de formulário enviado

Quando é acionado

Este evento é acionado quando um usuário completa e envia um formulário personalizado na interface de bate-papo.

Comportamento de parâmetro

  • Suporta parâmetros dinâmicos de campos de formulário

  • Os nomes dos campos do formulário devem corresponder exatamente aos espaços reservados usados na configuração da API REST

Como configurar

Etapa 1: Criar um formulário personalizado

Crie um formulário personalizado com nomes de campo claramente definidos.

Exemplo:

Nome do campo do formulário

Tipo de campo

Descrição

e-mail

E-mail

Endereço de e-mail do usuário

nome

Texto

Nome do usuário

empresa

Texto

Nome da empresa

mensagem

Texto

Mensagem do usuário

Etapa 2: Configurar a ação da API REST

Use espaços reservados na solicitação da API onde o sufixo corresponda ao nome do campo do formulário.

Os espaços reservados podem incluir prefixos como contato., agente. ou ação., mas a correspondência é baseada apenas no sufixo (a parte após o último .).

Exemplos:

  • Campo do formulário e-mail{{e-mail}} ou {{contato.e-mail}}

  • Campo do formulário nome{{nome}} ou {{contato.nome}}

  • Campo do formulário empresa{{empresa}} ou {{contato.empresa}}

Regras de correspondência de parâmetro

Campo do formulário

Espaço reservado

Corresponde

Motivo

e-mail

{{e-mail}}

Sim

Correspondência direta

e-mail

{{contato.e-mail}}

Sim

Sufixo e-mail corresponde

nome

{{contato.nome}}

Sim

Sufixo nome corresponde

nome

{{agente.nome}}

Sim

Sufixo nome corresponde

nomeusuário

{{contato.nome}}

Não

Sufixo não corresponde (diferenciação de maiúsculas e minúsculas)

e-maildo usuário

{{contato.e-mail}}

Não

Sufixo não corresponde (e-maildo usuárioe-mail)

Importante: O sufixo do espaço reservado deve corresponder exatamente ao nome do campo do formulário, incluindo a diferenciação de maiúsculas e minúsculas. O prefixo não afeta a correspondência.

Exemplo de fluxo

3. Evento de lead capturado

Quando é acionado

Este evento é acionado automaticamente 10 minutos após o fim da conversa, se o agente de IA tiver coletado informações de lead durante o bate-papo.

Comportamento de parâmetro

  • Usa uma estrutura de corpo de solicitação fixa

  • Você não pode personalizar ou modificar os campos enviados

Estrutura de corpo de solicitação fixa

Quando este evento é acionado, Wati envia automaticamente a seguinte carga:

{
"agent_id": "agent_id",
"data": {
"conversation_id": "conversation_id",
"details": "Lead details",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe",
"lead_level": "Hot",
"lead_score": 100,
"lead_summary": "Lead summary",
"max_score": 100
},
"event": "lead_captured"
}

Descrições de campo

Campo

Descrição

id_agente

ID do agente de IA

id_conversa

Identificador único de conversa

detalhes

Informações do lead coletadas

e-mail

E-mail do usuário (se disponível)

nome

Nome do usuário

sobrenome

Sobrenome do usuário

nivel_lead

Qualidade do lead (Quente, Morno, Frio)

pontuacao_lead

Pontuação numérica do lead

resumo_lead

Resumo do lead gerado pelo AI

pontuacao_maxima

Pontuação máxima possível

Nota: Você não precisa definir um corpo_da_solicitacao para eventos de Lead capturado. Qualquer configuração de corpo de solicitação personalizado será ignorada.

Casos de uso comuns

  • Criar leads automaticamente no Salesforce ou HubSpot

  • Enviar dados de lead para ferramentas de automação de marketing

  • Acionar fluxos de trabalho de follow-up no seu CRM

Referência Rápida: Comparação de Tipo de Evento

Recurso

Polegar para cima/baixo

Formulário enviado

Lead capturado

Parâmetros dinâmicos

Não

Sim

Estrutura fixa

Corpo de solicitação personalizado

Sim (apenas estático)

Sim

Não

Requer configuração de formulário

Não

Sim

Não

Tempo de acionamento

Imediato

Imediato

10 min após o fim do bate-papo

Ação do usuário necessária

Clique no feedback

Enviar formulário

Nenhuma (automático)

Escolhendo o tipo de evento certo

  • Use Polegar para cima / baixo para rastreamento de feedback simples

  • Use Formulário enviado quando precisar de entrada de usuário dinâmica

  • Use Lead capturado para entrega de lead automatizada após conversas

Selecionar o evento certo garante que as ações da API REST sejam executadas de forma confiável e enviem os dados esperados.

Respondeu à sua pergunta?