Webhook entrante

Los webhooks son una función poderosa en OneChat que te permite integrar tu propia plataforma con la automatización de chat de OneChat. Esto es útil si tienes tu propia plataforma de chat en vivo y quieres aprovechar las funciones de automatización de OneChat sin dirigir a los usuarios a la interfaz de OneChat.

¿Quién debería usar Webhooks?

Los webhooks están diseñados para desarrolladores que tienen su propia plataforma y algo de experiencia trabajando con API.

Cómo configurar Webhooks en OneChat

Aquí tienes una guía paso a paso sobre cómo configurar webhooks en OneChat:

1. Configura tu URL de Webhook:

• Ve a Integrations y luego a Webhooks.

• Opcionalmente, puedes configurar tus propios headers para mayor seguridad.

• Proporciona una URL de Webhook donde quieras recibir los datos.

1. Habilita Webhooks en la configuración de tu canal:

• Ve a la configuración del canal del chat que quieres integrar con tu plataforma (por ejemplo, WhatsApp, SMS).

• En Live Chat Settings, selecciona Webhook.

1. Usa la acción Pause the Bot:

• En tu flujo de OneChat, incluye la acción Pause the Bot donde quieras que la conversación cambie a tu plataforma.

• Cuando un usuario interactúe después de este punto, el mensaje se enviará a tu URL de Webhook.

Payload de ejemplo

Los datos que OneChat envía a tu URL de Webhook son un payload JSON que incluye varios detalles sobre el mensaje y la conversación. Aquí tienes un desglose del payload de ejemplo de la imagen:

• meta

• user_ns: Este es un identificador único del usuario.

• agent_id: Este es el ID del agente asignado actualmente a la conversación (0 indica que no hay un agente asignado).

• flow_ns: Este es un identificador único del flujo de chat.

• team_id: Este es el ID del equipo al que pertenece el chat.

• message

• _id: Este es un identificador único del mensaje.

• mid: Este es un identificador único del mensaje dentro del canal.

• type: Esto indica el tipo de mensaje (por ejemplo, "in" para mensaje entrante).

• msg_type: Esto especifica el tipo de contenido del mensaje (por ejemplo, "text").

• sender_id: Este es el ID del remitente del mensaje.

• agent_id: Este es el ID del agente que recibió el mensaje (0 indica que no hay un agente asignado).

• assigned_agent_id: Este es el ID del agente asignado a la conversación después de recibir el mensaje.

• payload

text: Esto contiene el contenido de texto del mensaje.

• content: Esto también contiene el contenido de texto del mensaje.

• username: Este es el nombre de usuario del remitente del mensaje.

• date: Esto muestra la fecha en que se envió el mensaje.

• timestamp: Esta es la marca de tiempo del mensaje en milisegundos.

• ts: Esta es otra representación de la marca de tiempo del mensaje.

• is_delivered: Esto indica si el mensaje fue entregado (1 significa entregado).

• seen: Este campo aparece vacío en el payload de ejemplo, pero puede indicar si el mensaje fue visto.

Uso de la API de OneChat

Una vez que captures el mensaje del usuario en tu plataforma, puedes usar la API de OneChat para enviar una respuesta al usuario dentro de la conversación de chat. La API de OneChat usa user_ns y flow_ns del payload para identificar la conversación y enviar el mensaje.

Consideraciones adicionales

• Los webhooks son una herramienta poderosa, pero requieren experiencia en desarrollo.

• OneChat admite varios tipos de mensaje, y el payload reflejará el tipo de contenido (texto, imagen, etc.).

• Aprovecha la API de OneChat para comunicarte de ida y vuelta entre tu plataforma y los usuarios de OneChat.

Siguiendo estos pasos y comprendiendo los datos del payload, puedes configurar correctamente webhooks para integrar tu propia plataforma con las funciones de automatización de OneChat.

Tutorial en video aquí:

TODO_VIDEO[2b0817844d]: reemplazar este video con un recurso oficial de OneChat.

Po