Configuração do Webhook
Para habilitar webhooks de conversa encerrada:- Use o Habilitar Webhook de Conversa Encerrada endpoint da API
- Forneça sua URL de webhook onde as notificações serão enviadas
- Opcionalmente, configure variáveis pós-chamada em seu assistente para extrair dados estruturados das conversas
Formato da Solicitação
O webhook é enviado como uma solicitação POST para sua URL configurada com o seguinte payload JSON:Estrutura do Payload
integer
Identificador numérico da conversa (o mesmo id mostrado na URL da conversa do dashboard). Use
conversation_id (UUID) ao chamar a API.string
Identificador único (UUID) da conversa
string
Identificador único (UUID) do assistente que gerenciou a conversa
string
O tipo de conversa. Valores possíveis:
widget, whatsappinteger
Número total de mensagens trocadas na conversa
string
Status da conversa. Valor:
endedobject
Variáveis extraídas pela IA com base 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 (por exemplo, de campos de formulário pré-chat ou fluxos de automação)
array
Array de objetos de mensagem representando a conversa completa, ordenada do mais antigo para o mais recente
string
Transcrição formatada legível por humanos com prefixos
AI: e Customer:array
Arquivos de mídia (imagens, vídeos, documentos) compartilhados durante a conversa. Cada entrada inclui uma URL direta que você pode passar para serviços externos (por exemplo, análise de imagem ou vídeo). Este é um array vazio quando nenhuma mídia foi compartilhada — a mídia está tipicamente presente em conversas do WhatsApp.
string
Número de telefone do cliente (disponível para conversas do WhatsApp,
null para conversas do widget)string
Nome do cliente, se fornecido (por exemplo, do formulário pré-chat), ou
nullobject
Informações do remetente do WhatsApp (apenas presente para conversas do WhatsApp,
null para widget)string
Timestamp ISO 8601 quando a conversa começou (no fuso horário configurado pelo usuário)
string
Timestamp ISO 8601 quando a conversa terminou (no fuso horário configurado pelo usuário)
Comportamento de Retentativa
Se seu endpoint de webhook retornar um código de status diferente de 2xx ou a solicitação falhar, o sistema tentará novamente:
Após 3 tentativas falhadas, a entrega do webhook é marcada como falhada e nenhuma nova tentativa é feita.
Notas Importantes
- O
conversation_ide oassistant_idsão UUIDs, não IDs inteiros - O campo
senderé preenchido apenas para conversas do WhatsApp — ele seránullpara conversas do widget - O
customer_phoneestá disponível apenas para conversas do WhatsApp - O
customer_namevem de dados do formulário pré-chat ou do contexto da conversa - Os timestamps usam o fuso horário configurado pelo usuário (formato ISO 8601)
- As
extracted_variablessão preenchidas a partir da avaliação do esquema pós-chamada do seu assistente - As
input_variablescontêm dados de formulários pré-chat (widget) ou fluxos de automação - O array
attachmentslista mídias (imagens, vídeos, documentos) compartilhadas durante a conversa, cada uma com umaurlpara download — útil para encaminhar para ferramentas de análise externas. É um array vazio quando nenhuma mídia foi compartilhada (mais comum em conversas do widget)

