Skip to main content
API de Famulor 1.0 (legado). Esta página se aplica únicamente a Famulor 1.0 (app.famulor.de) y se conserva por compatibilidad. Para la plataforma actual, usa la referencia de la API de Famulor 2.0.
Webhook enviado al finalizar una conversación de chat, con la transcripción, las variables extraídas y los datos del cliente
El webhook de conversación finalizada se envía automáticamente a la URL de webhook que hayas especificado cuando finaliza una conversación de chat (WhatsApp o widget web). Este webhook contiene la transcripción completa, las variables extraídas, la información del cliente y los datos del remitente.

Configuración del webhook

Para activar los webhooks de conversación finalizada:
  1. Usa el endpoint de la API Activar webhook de conversación finalizada
  2. Proporciona la URL de webhook a la que se enviarán las notificaciones
  3. Opcionalmente, configura variables posteriores a la llamada en tu asistente para extraer datos estructurados de las conversaciones

Formato de la solicitud

El webhook se envía como una solicitud POST a tu URL configurada con el siguiente payload JSON:

Estructura del payload

integer
Identificador numérico de la conversación (el mismo id que se muestra en la URL de la conversación en el panel). Usa conversation_id (UUID) al llamar a la API.
string
Identificador único (UUID) de la conversación
string
Identificador único (UUID) del asistente que gestionó la conversación
string
El tipo de conversación. Valores posibles: widget, whatsapp
integer
Número total de mensajes intercambiados en la conversación
string
Estado de la conversación. Valor: ended
object
Variables extraídas por la IA según la configuración del esquema posterior a la llamada de tu asistente
object
Variables que se pasaron al asistente al inicio de la conversación (por ejemplo, desde campos de formulario previo al chat o flujos de automatización)
array
Array de objetos de mensaje que representan la conversación completa, ordenados del más antiguo al más reciente
string
Transcripción formateada y legible por humanos, con los prefijos AI: y Customer:
array
Archivos multimedia (imágenes, vídeos, documentos) compartidos durante la conversación. Cada entrada incluye una URL directa que puedes pasar a servicios externos (por ejemplo, análisis de imagen o vídeo). Es un array vacío cuando no se compartió ningún archivo multimedia — suele estar presente en las conversaciones de WhatsApp.
string
Número de teléfono del cliente (disponible en las conversaciones de WhatsApp, null en las del widget)
string
Nombre del cliente si se proporcionó (por ejemplo, desde el formulario previo al chat), o null
object
Información del remitente de WhatsApp (solo presente en las conversaciones de WhatsApp, null en las del widget)
string
Marca de tiempo ISO 8601 de cuándo comenzó la conversación (en la zona horaria configurada del usuario)
string
Marca de tiempo ISO 8601 de cuándo finalizó la conversación (en la zona horaria configurada del usuario)

Comportamiento de reintentos

Si tu endpoint de webhook devuelve un código de estado que no sea 2xx o la solicitud falla, el sistema reintentará el envío: Después de 3 intentos fallidos, la entrega del webhook se marca como fallida y no se realizan más reintentos.

Notas importantes

  • conversation_id y assistant_id son UUID, no ID enteros
  • El campo sender solo se rellena en las conversaciones de WhatsApp; es null en las conversaciones del widget web
  • customer_phone solo está disponible en las conversaciones de WhatsApp
  • customer_name proviene de los datos del formulario previo al chat o del contexto de la conversación
  • Las marcas de tiempo usan la zona horaria configurada del usuario (formato ISO 8601)
  • extracted_variables se rellena a partir de la evaluación del esquema posterior a la llamada de tu asistente
  • input_variables contiene datos de formularios previos al chat (widget web) o de flujos de automatización
  • El array attachments enumera los archivos multimedia (imágenes, vídeos, documentos) compartidos durante la conversación, cada uno con una url descargable — útil para reenviarlos a herramientas externas de análisis. Es un array vacío cuando no se compartió ningún archivo multimedia (lo más habitual en las conversaciones del widget web)