Productos compatibles
Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing HubPro
Sales HubSales HubPro
Service HubService HubPro
Content HubContent HubPro
Última modificación: 22 de agosto de 2025
Utiliza la API de identificación de visitantes para identificar a los visitantes de tu sitio web que se autenticaron utilizando tu sistema de autenticación externo. El token de identificación que devuelve esta API se puede utilizar para pasar información sobre el visitante ya autenticado al widget de chat, de modo que se trate al visitante como un contacto conocido. De esta forma, los agentes que reciben los mensajes en la bandeja de entrada pueden estar seguros de saber con quién están hablando y los visitantes pueden acceder al historial de conversaciones previas en todos sus dispositivos. Por ejemplo, si gestionas el acceso a tu aplicación web mediante un inicio de sesión, puedes configurar el widget de chat de HubSpot para que aparezca en las páginas dentro de tu aplicación web donde sabes que los visitantes ya han sido autenticados e identificados. Actualmente, cualquier visitante que chatee en alguna de esas páginas seguirá apareciendo como “Visitante desconocido” en la bandeja de entrada de conversaciones, a pesar de ser un visitante identificado y registrado en tu aplicación web. Usando la API de identificación de visitantes, puedes pasar información autenticada del visitante directamente al widget de chat, que los identifica en la bandeja de entrada de conversaciones.

Nota:

  • La API de identificación de visitantes sirve para decirle a HubSpot quién es el visitante. No debes confiar en ella para autenticar a los usuarios en tu plataforma.
  • El acceso a la API de identificación de visitantes requiere una suscripción nivel Pro o Enterprise. Si la cuenta no tiene una suscripción válida, recibirás una respuesta de error 403 de la API.

Ejemplo del flujo de integración

Para configurar una integración con esta característica, debes tener una aplicación web con un sistema de autenticación. Antes de comenzar, asegúrate de tener una aplicación privada configurada y de que la cuenta que intentas integrar tenga una suscripción nivel Pro o Enterprise que cumpla con los requisitos. Este es un ejemplo de un posible flujo de integración:
Posible flujo de identificación del usuario
Una vez que el cliente haya iniciado sesión y haya sido verificado en tu sistema, sigue estos pasos para identificarlo en el live chat: 1. En el front end, define loadImmediately como false para el objeto hsConversationsSettings en la ventana. Si no lo haces, el widget de chat se puede cargar antes de que se pase la información de identificación. Para más información, consulta el manual del SDK de widgets de chat.
  • Define las propiedades de hsConversationsSettings fuera de la función isConversationsAPIReady.
  • Además, hsConversationsSettings debe definirse antes de la llamada; de lo contrario, puede producirse una condición de carrera que interfiera con la carga del widget.
window.hsConversationsSettings = {
  loadImmediately: false,
};
2. Genera un token a partir de la API de identificación de visitantes introduciendo la dirección de correo electrónico del visitante autenticado. Esto debe hacerse en el back end de la aplicación web. Consulta la documentación de referencia de endpoints para ver un ejemplo de solicitud.
curl --request POST \
  --url 'https://api.hubspot.com/conversations/v3/visitor-identification/tokens/create \
--data '{
  "email": "gob@bluth.com",
  "firstName": "Gob",
  "lastName": "Bluth"
}'
El nombre y apellidos proporcionados se definirán en el registro del contacto en HubSpot después de que comience el chat si:
  • Es un nuevo contacto creado por la API de identificación de visitantes.
  • Es un contacto existente cuyo nombre aún no se conoce.
Esto puede ser útil al personalizar mensajes para visitantes identificados cuando tu sistema externo ya tiene información sobre su nombre, pero esta información aún no existe en HubSpot. Se trata de parámetros opcionales y no son obligatorios.
3. Utilizando el token del paso 2, define las siguientes propiedades en el objeto hsConversationsSettings de la ventana.
window.hsConversationsSettings = {
  identificationEmail: 'visitor-email@example.com',
  identificationToken: '<TOKEN FROM STEP 1>',
};
4. Carga el widget.
window.HubSpotConversations.widget.load();
El token y el correo electrónico deben definirse en el objeto hsConversationsSettings de la ventana cada vez que se cargue la página para un visitante autenticado. Este contexto no se transferirá automáticamente entre cargas de página si estos parámetros ya no están definidos. Los tokens son temporales y caducarán después de 12 horas. Los tokens se pueden almacenar en caché para evitar obtener el token cada vez que se carga la página, siempre y cuando se actualicen al menos cada 12 horas.

Verifica la integración

Una vez que hayas completado la integración de la característica de identificación de visitantes, puedes comprobar que funciona como esperabas. Esto puede hacerse de diferentes maneras, dependiendo de tu implementación, por lo que puede que tengas que adaptar los siguientes ejemplos a tus requisitos en específico.
  • Si agregaste el widget de chat a una o más páginas públicas, así como detrás de un sistema de autenticación:
    • Navega hasta una página en la que el widget de chat no deba identificar a los visitantes e inicia una conversación.
    • En HubSpot, abre la bandeja de entrada y comprueba que el chat que acaba de entrar pertenece a un Visitante desconocido. Si no es así, realiza una prueba siguiendo estos pasos en una ventana de navegación privada:
      • Ve a una página en la que el widget de chat deba identificar a los visitantes mediante la API de identificación de visitantes e inicia una conversación.
      • En HubSpot, abre la bandeja de entrada y comprueba que el chat se atribuye correctamente al contacto con el que has iniciado sesión. Deberías ver un indicador junto al nombre del contacto, que confirma que se identificó correctamente a través de esta API.
visitor_identity_badge
  • Si solo has agregado el widget de chat a páginas tras el sistema de autenticación y tienes acceso a varias cuentas de usuario de prueba:
    • Inicia sesión en HubSpot como el primer usuario de prueba, luego ve a una página donde se cargue el widget de chat e inicia una conversación.
    • Cierra sesión en HubSpot, luego vuelve a entrar como el segundo usuario de prueba. Ve a una página donde se cargue el widget de chat y comienza una conversación.
    • En HubSpot, abre la bandeja de entrada y comprueba que los chats que entraron proceden de la primera y segunda cuenta de prueba, respectivamente y que ves el indicador junto a los nombres de contacto de ambos registros.

Nota:

Para los visitantes identificados con esta API, HubSpot no instalará la cookie messagesUtk. HubSpot también omitirá cualquier pregunta para solicitar el correo electrónico, ya que la dirección ya es conocida. Dado que la cookie messagesUtk y la solicitud de correo electrónico no se aplican a estos chats, la configuración asociada en el chatflow no se mostrará para los visitantes identificados a través de la API de identificación de visitantes.

Introducción al SDK del widget de chat

La API está alojada en el objeto window.HubSpotConversations, a través del cual se puede acceder a todos los métodos disponibles. El cargador de scripts de HubSpot creará este objeto automáticamente en tu página, pero es posible que no esté disponible de inmediato. Para aplazar el acceso a la API hasta que esté inicializada, puedes utilizar el ayudante window.hsConversationsOnReady. Por ejemplo:
<script type="text/javascript">
  function onConversationsAPIReady() {
    console.log(`HubSpot Conversations API: ${window.HubSpotConversations}`);
  }
  /*
    configure window.hsConversationsSettings if needed.
  */
  window.hsConversationsSettings = {};
  /*
   If external API methods are already available, use them.
  */
  if (window.HubSpotConversations) {
    onConversationsAPIReady();
  } else {
    /*
      Otherwise, callbacks can be added to the hsConversationsOnReady on the window object.
      These callbacks will be called once the external API has been initialized.
    */
    window.hsConversationsOnReady = [onConversationsAPIReady];
  }
</script>

Referencia del SDK

Matriz window.hsConversationsOnReady Es un campo opcional que puedes definir en el objeto ventana y que te permite especificar el código que se ejecutará en cuanto el widget esté disponible. Una vez que la API haya sido inicializada, comprobará la existencia de esta matriz y ejecutará las funciones en series.
if (window.HubSpotConversations) {
  console.log('The api is ready already');
} else {
  window.hsConversationsOnReady = [
    () => {
      console.log('Now the api is ready');
    },
  ];
}
Objeto hsConversationsSettings Este objeto te permite proporcionar algunas opciones de configuración al widget antes de que se inicialice. Para usar la característica de identificación de visitantes, debes definir los siguientes campos:
ParámetroTipoDescripciónPredeterminado
loadImmediatelybooleanoSi el widget debe cargarse automáticamente o esperar hasta que se llame al método widget.loadtrue
identificationTokencadenaSe utiliza para integrarse con la API de identificación de visitantes. Este es el token proporcionado por el endpoint de generación de tokens de la API de identificación de visitantes, que se usa como prueba de que el visitante ha sido identificado.""
identificationEmailcadenaLa dirección de correo electrónico del visitante que has identificado como el que carga el widget.""
window.hsConversationsSettings = {
  loadImmediately: false,
  identificationEmail: 'visitor-email@example.com',
  identificationToken: '<TOKEN FROM STEP 1>',
};
Más información sobre el SDK de conversaciones.