Skip to main content
O Webhook de Conversa Finalizada é automaticamente enviado para sua URL de webhook especificada após uma conversa de chat (WhatsApp ou Widget Web) terminar. Este webhook contém a transcrição completa, variáveis extraídas, informações do cliente e detalhes do remetente.

Configuração do Webhook

Para ativar webhooks de conversa finalizada:
  1. Use o endpoint da API Enable Conversation Ended Webhook
  2. Forneça sua URL de webhook onde as notificações serão enviadas
  3. Opcionalmente configure variáveis pós-chamada no seu assistente para extrair dados estruturados das conversas

Formato da Requisição

O webhook é enviado como uma requisição POST para sua URL configurada com a seguinte carga JSON:

Estrutura da Carga

string
Identificador único (UUID) da conversa
string
Identificador único (UUID) do assistente que handling a conversa
string
O tipo de conversa. Valores possíveis: widget, whatsapp
integer
Número total de mensagens trocadas na conversa
string
Status da conversa. Valor: ended
object
Variáveis extraídas pela IA baseadas na configuração do esquema pós-chamada do seu assistente
object
Variáveis que foram passadas para o assistente no início da conversa (ex: de campos de formulário pré-chat ou fluxos de automação)
array
Array de objetos de mensagem representando a conversa completa
string
Transcrição formatada legível para humanos com prefixos AI: e Customer:
string
Número de telefone do cliente (disponível para conversas WhatsApp, null para conversas de widget)
string
Nome do cliente se fornecido (ex: de formulário pré-chat), ou null
object
Informações do remetente WhatsApp (apenas presente para conversas WhatsApp, null para widget)
string
Timestamp ISO 8601 quando a conversa começou (no fuso horário configurado do usuário)
string
Timestamp ISO 8601 quando a conversa terminou (no fuso horário configurado do usuário)

Comportamento de Tentativa

Se seu endpoint de webhook retornar um código de status não-2xx ou a requisição falhar, o sistema tentará novamente: Após 3 tentativas falharam, a entrega do webhook é marcada como falhou e nenhuma tentativa adicional é feita.

Notas Importantes

  • Os conversation_id e assistant_id são UUIDs, não IDs de inteiros
  • O campo sender é apenas preenchido para conversas WhatsApp — será null para conversas de widget web
  • O customer_phone está disponível apenas para conversas WhatsApp
  • O customer_name vem de dados de formulário pré-chat ou contexto da conversa
  • Timestamps usam o fuso horário configurado do usuário (formato ISO 8601)
  • As extracted_variables são preenchidas a partir da avaliação do esquema pós-chamada do seu assistente
  • As input_variables contêm dados de formulários pré-chat (widget web) ou fluxos de automação