En WikiChat, los webhooks te permiten integrar tu plataforma con nuestra automatización de chat de manera sencilla. Así puedes utilizar nuestras funciones sin dirigir a tus contactos a la interfaz de WikiChat.
¿Quién debe usar los webhooks?
Esta función está pensada para desarrolladores con experiencia usando APIs y manejo de plataformas externas.
Paso a paso para configurar un webhook
- Configura tu URL de Webhook:
- Entra a Integraciones y luego a Webhooks.
- Puedes agregar encabezados propios para mayor seguridad.
- Proporciona la URL donde deseas recibir la información.
- Activa el Webhook en tu Canal:
- Ingresa a la configuración del canal (por ejemplo, WhatsApp o SMS).
- En Configuración de Chat en Vivo, selecciona Webhook.
- Utiliza la acción Pausar Automatización:
- Incluye "Pausar Automatización" en tu flujo donde quieras pasar la conversación a tu plataforma.
- Tras ese punto, cualquier mensaje del contacto será enviado a tu Webhook URL.
Ejemplo de payload
El contenido enviado a tu Webhook es un JSON con estos campos principales:
- meta: identificadores de usuario, agente, flujo y equipo.
- message: ID del mensaje, tipo, remitente, tipo de contenido, IDs de agente.
- payload: texto del mensaje, usuario, fecha, timestamp, estado de entrega y visto.
{
"meta": {
"user_ns": "Identificador único del contacto",
"agent_id": "ID del agente",
"flow_ns": "Identificador único del flujo",
"team_id": "ID del equipo"
},
"message": {
"_id": "ID único del mensaje",
"mid": "ID en el canal",
"type": "Tipo de mensaje",
"msg_type": "Tipo de contenido",
"sender_id": "ID del remitente",
"assigned_agent_id": "ID del agente asignado"
},
"payload": {
"text": "Texto del mensaje",
"username": "Usuario",
"date": "Fecha",
"timestamp": "En milisegundos",
"is_delivered": 1,
"seen": "Campo visto (puede estar vacío)"
}
}
Cómo responder usando la API de WikiChat
Al recibir el mensaje, puedes usar la API de WikiChat para responderle al contacto. Usa los campos user_ns y flow_ns para dirigir el mensaje a la conversación correcta.
Recuerda que los webhooks permiten manejar diversos tipos de mensajes y requieren conocimientos técnicos. Consulta nuestra documentación de API para más detalles.