API
Webhook

6min
Una excelente manera de incorporar las conversaciones dentro de tu propio sistema es a través de la implementación de un webhook hacia tu servicio web. Este proceso te permitirá establecer una conexión bidireccional entre tu sistema y el chat, lo cual resultará en una integración mucho más fluida y eficiente.
Es importante destacar que la URL que ingreses en el webhook se ejecutará cuando se archive la conversación. Esto significa que la URL recibirá un JSON con toda la información de la conversación en formato JSON una vez que la conversación haya sido archivada. Puede ser que el bot archive la conversación automáticamente o que un agente lo haga manualmente.
Para llevar a cabo la configuración del webhook, deberás dirigirte a la sección de configuración de la plataforma y acceder a la pestaña de webhooks. Una vez allí, serás capaz de ingresar la URL correspondiente a tu sistema, la cual servirá como punto de enlace para el intercambio de información.
﻿
Asegúrate de ingresar la dirección web de tu sistema de manera precisa y verídica, ya que esto será crucial para garantizar una correcta comunicación. Una vez establecido el webhook, podrás comenzar a recibir y procesar los datos provenientes de las conversaciones archivadas, permitiéndote así personalizar y adaptar la experiencia del usuario de acuerdo a tus propias necesidades y requerimientos.
En resumen, la implementación de un webhook hacia tu servicio web es un enfoque altamente recomendado para integrar conversaciones en tu sistema. Te brinda mayor control y flexibilidad, además de proporcionarte toda la información de la conversación en un formato JSON una vez que la conversación haya sido archivada. Aprovecha esta funcionalidad para automatizar procesos y mejorar la interacción con los usuarios de manera eficiente.
Ejemplo de JSON enviado
JS
{
   "event_type": "TICKET.CLOSED",
   "ticket_id": "#1FY",
   "timestamp": 1586229907754,
   "channel": "WEB",
   "source": "CHAT",
   "source_id": null,
   "status": "CLOSED",
   "subject": "I'm interested in the new red shoes",
   "department": {
      "id": 93,
      "name": "Customer support"
   },
   "bot": {
      "id": 25478,
      "name": "Agustin",
      "transferred_to_agent": true
   },
   "agent": {
      "id": 569884,
      "name": "Agustin",
      "email": "[email protected]"
   },
   "customer": {
      "fingerprint": "k811xkn31fhzcss0dia8bbd3sr56l20lpx6gx76y",
      "name": "John",
      "email": "[email protected]",
      "phone": "",
      "facebook_id": "",
      "sentiment": "",
      "ip": "95.256.142.145",
      "browser_os": "Chrome on Windows 10 64-bit",
      "country_code": "US",
      "country_name": "United States"
   },
   "event": {
      "calendar_id": "1",
      "base36_id": "HX34S",
      "customer_locale": "es",
      "customer_timezone": "-3",
      "event_status": "ACTIVE",
      "event_url": "",
      "friendly": "Chrome on Windows 10 64-bit",
      "location": "Av. Libertador 2632, Olivos"
   },
   "messages": [
      {
         "action": "OUT",
         "timestamp": 1586229888461,
         "name": "Bruno",
         "message": "Hi John! I'm Bruno, a virtual assistant. How can I help you?"
      },
      {
         "action": "IN",
         "timestamp": 1586229891562,
         "name": "John",
         "message": "I'm interested in the new red shoes"
      },
   ]
}
{
   "event_type": "TICKET.CLOSED",
   "ticket_id": "#1FY",
   "timestamp": 1586229907754,
   "channel": "WEB",
   "source": "CHAT",
   "source_id": null,
   "status": "CLOSED",
   "subject": "I'm interested in the new red shoes",
   "department": {
      "id": 93,
      "name": "Customer support"
   },
   "bot": {
      "id": 25478,
      "name": "Agustin",
      "transferred_to_agent": true
   },
   "agent": {
      "id": 569884,
      "name": "Agustin",
      "email": "agustin@fabrics-l.com"
   },
   "customer": {
      "fingerprint": "k811xkn31fhzcss0dia8bbd3sr56l20lpx6gx76y",
      "name": "John",
      "email": "john@gmail.com",
      "phone": "",
      "facebook_id": "",
      "sentiment": "",
      "ip": "95.256.142.145",
      "browser_os": "Chrome on Windows 10 64-bit",
      "country_code": "US",
      "country_name": "United States"
   },
   "event": {
      "calendar_id": "1",
      "base36_id": "HX34S",
      "customer_locale": "es",
      "customer_timezone": "-3",
      "event_status": "ACTIVE",
      "event_url": "",
      "friendly": "Chrome on Windows 10 64-bit",
      "location": "Av. Libertador 2632, Olivos"
   },
   "messages": [
      {
         "action": "OUT",
         "timestamp": 1586229888461,
         "name": "Bruno",
         "message": "Hi John! I'm Bruno, a virtual assistant. How can I help you?"
      },
      {
         "action": "IN",
         "timestamp": 1586229891562,
         "name": "John",
         "message": "I'm interested in the new red shoes"
      },
   ]
}
﻿
Headers
El encabezado siempre tendrá el valor AsisteClick-Access-Token con el access token de la cuenta. Este token es esencial para autenticar y autorizar el acceso a la cuenta del cliente en el servicio web.
El access token de la cuenta lo obtiene cualquier usuario con nivel de administrador.
Por otro lado, en caso de que el servicio web del cliente requiera de valores de encabezado adicionales, estos se agregarán en la misma URL con un formato especial. Este formato asegura que los valores de encabezado se transmitan correctamente al servidor y se utilicen de acuerdo a las necesidades del cliente.
https://www.tuempresa.com/tuservicio::origen:bot
Para agregar headers al final de la URL, se debe escribir "::" para separar la URL del header adicional. A continuación, se debe especificar el nombre del header seguido de ":" y el valor correspondiente. En el ejemplo mencionado anteriormente, el nombre del header es "origen" y el valor es "bot".
En caso de necesitar varios headers, se separan por ";". Por ejemplo: 
https://www.tuempresa.com/tuservicio::origen:bot;servicio:web
En este último ejemplo, el webhook será enviado a la url https://www.tuempresa.com/tuservicio agregando en el header los valores origen=bot y servicio=web.
Tipos de eventos (event_type)
La plataforma realiza el callback a la URL cuando se ocurren los siguientes eventos:
Conversación archivada por un chatbot: event_type = TICKET.HANDOFF
Conversación archivada por un usuario: event_type = TICKET.CLOSED
Creación de un evento de agenda: event_type = EVENT.CREATED
Actualización de un evento de agenda: event_type = EVENT.UPDATED
Cancelación de un evento de agenda: event_type = EVENT.CANCELED
﻿
﻿
Updated 29 Jun 2024
Did this page help you?
Formulario a Conversación
Integraciones