Usar webhooks con workflows de HubSpot
Última actualización: junio 11, 2024
Disponible con cualquiera de las siguientes suscripciones, a no ser que se indique de otro modo:
Operations Hub Pro , Enterprise |
Usa webhooks en workflows para enviar u obtener información entre HubSpot y otras herramientas externas. Los webhooks pueden usarse de muchas formas, y entre los ejemplos de uso más populares, se incluyen los siguientes:
-
Publicando datos de contacto de HubSpot en otro sistema, como un CRM, cuando ese contacto rellena un formulario concreto en tu sitio.
-
Enviar datos de negocios a un sistema externo de gestión de envíos para crear un pedido.
- Obtener datos de otro sistema para actualizar los registros de HubSpot.
Puedes enviar solicitudes POST y GET utilizando workflows. HubSpot regula el tráfico de webhooks por separado de otros de los procesos de los workflows. Esto se hace para optimizar el rendimiento de workflow y el del webhook. Cuando un webhook es lento o agota el tiempo de espera, la acción del workflow puede tardar más de lo esperado.
Nota: cuando un webhook falla, HubSpot vuelve a intentar ejecutarlo durante un máximo de tres días, comenzando un minuto después del fallo. Los fallos posteriores se volverán a intentar a intervalos cada vez mayores, con un intervalo máximo de ocho horas entre intentos. Los workflows no reintentarán tras recibir códigos de estado de respuesta de la serie 4XX.
Una excepción a esta regla son los errores de límite de velocidad 429; los workflows reintentarán automáticamente tras recibir una respuesta 429, y respetarán la cabecera Retry-After si está presente. El Retry-After se registra en milisegundos. Para saber qué excepciones se aplican a códigos de error específicos, consulta la documentación para desarrolladores de HubSpot.
Puedes consultar más información sobre los webhooks en la documentación para desarrolladores. Si tienes preguntas sobre una implementación específica, puedes publicarla en los foros de HubSpot para desarrolladores.
Configurar una solicitud POST
- En tu cuenta de HubSpot, dirígete a Automatizaciones > Workflows.
- Para editar un workflow existente, haz clic en el nombre del workflow. O, crea un nuevo workflow.
- En el Editor de flujos de trabajo, haz clic en + icono de signo más para añadir una acción.
- En el panel izquierdo, en la sección Operaciones de datos, selecciona Enviar un webhook.
- Clic en el menú desplegable Método y selecciona POST.
- Introduce la URL del webhook.
- Las URL de los webhooks están restringidas a un protocolo de seguridad y deben comenzar con HTTPS.
- Para solicitar información específica, puedes agregar parámetros de consulta, como
?queryparameter=abc
, a la URL del webhook. - Si no se han agregado parámetros de consulta, se enviará una solicitud genérica POST o GET.
- Configura tu tipo de autenticación para autentificar las solicitudes a tu webhook. Puedes utilizar una firma de solicitud en el encabezado de tu webhook o utilizar una Clave de API:
- Para utilizar una firma de solicitud en el encabezado del webhook:
- Haz clic en el menú desplegable Tipo de autenticación. A continuación, selecciona Incluye la firma de la solicitud en el título.
- Luego, introduce tu ID de aplicación de HubSpot. Consulta cómo verificar las solicitudes de firma.
- Para utilizar una firma de solicitud en el encabezado del webhook:
-
- Para utilizar una Clave de API o una aplicación pública creada a través de una cuenta de desarrollador para la autenticación:
-
-
- Cuando se utiliza una clave de API en la autenticación, el nombre de esa clave y su ubicación dependen de cómo esté configurado el webhook. Por razones de seguridad, la clave de API no se mostrará en ninguna solicitud de prueba. Para utilizar una clave de API:
- Haz clic en el menú desplegable Tipo de autenticación. Luego, selecciona Clave de API.
- Cuando se utiliza una clave de API en la autenticación, el nombre de esa clave y su ubicación dependen de cómo esté configurado el webhook. Por razones de seguridad, la clave de API no se mostrará en ninguna solicitud de prueba. Para utilizar una clave de API:
-
-
-
-
- Introduce el nombre de la clave de la API.
- Haz clic en el menú desplegable Ubicación de la clave de la API. Luego, selecciona Parámetros de consulta o Encabezado de la solicitud. Más información sobre el uso de las claves de las API en HubSpot.
- Si estás solicitando una API de HubSpot:
- Haz clic en el menú desplegable Clave de API y selecciona un secreto. El valor secreto debe tener el formato Bearer [TU_TOKEN].
- Define el valor del nombre de la clave de la API como Autorización.
- Define el valor Ubicación de la clave de la API como Encabezado de la solicitud.
-
-
- Para incluir todas las propiedades, selecciona Incluir todas las propiedades [del objeto].
- Para incluir solo propiedades específicas:
- Selecciona Personalizar cuerpo de la solicitud.
- Para personalizar el cuerpo de la solicitud utilizando una propiedad de HubSpot, introduce la Tecla y selecciona una propiedad . Para agregar otra propiedad, haz clic en Agregar propiedad.
- Para personalizar el cuerpo de la solicitud utilizando un campo estático, introduce la Tecla y Valor. Para añadir otra propiedad, haz clic en Añadir valor estático.
-
- Para eliminar una propiedad o un valor estático, haz clic en el icono de la papelera delete .
- Haz clic en Guardar.
Nota: para seleccionar varias salidas, la respuesta debe estructurarse como un objeto JSON.
Configurar una solicitud GET
- En tu cuenta de HubSpot, dirígete a Automatizaciones > Workflows.
- Para editar un workflow existente, haz clic en el nombre del workflow. O, crea un nuevo workflow.
- En el Editor de flujos de trabajo, haz clic en + icono de signo más para añadir una acción.
- En el panel izquierdo, en la sección Operaciones de datos, selecciona Enviar un webhook.
- Clic en el Menú desplegable Método y selecciona GET.
- Introduce la URL del webhook.
- Las URL de los webhooks están restringidas a un protocolo de seguridad y deben comenzar con HTTPS.
- Para solicitar información específica, puedes agregar parámetros de consulta, como
?queryparameter=abc
, a la URL del webhook. - Si no se han agregado parámetros de consulta, se enviará una solicitud genérica POST o GET.
- Configura tu tipo de autenticación para autentificar las solicitudes a tu webhook. Puedes utilizar una firma de solicitud en el encabezado de tu webhook o utilizar una Clave de API:
- Para utilizar una firma de solicitud en el encabezado del webhook:
- Haz clic en el menú desplegable Tipo de autenticación. A continuación, selecciona Incluye la firma de la solicitud en el título.
- Luego, introduce tu ID de aplicación de HubSpot. Consulta cómo verificar las solicitudes de firma.
- Para utilizar una firma de solicitud en el encabezado del webhook:
-
- Para utilizar una Clave de API o una aplicación pública creada a través de una cuenta de desarrollador para la autenticación:
-
-
- Cuando se utiliza una clave de API en la autenticación, el nombre de esa clave y su ubicación dependen de cómo esté configurado el webhook. Por razones de seguridad, la clave de API no se mostrará en ninguna solicitud de prueba. Para utilizar una clave de API:
- Haz clic en el menú desplegable Tipo de autenticación. Luego, selecciona Clave de API.
- Cuando se utiliza una clave de API en la autenticación, el nombre de esa clave y su ubicación dependen de cómo esté configurado el webhook. Por razones de seguridad, la clave de API no se mostrará en ninguna solicitud de prueba. Para utilizar una clave de API:
-
-
-
-
- Introduce el nombre de la clave de la API.
- Haz clic en el menú desplegable Ubicación de la clave de la API. Luego, selecciona Parámetros de consulta o Encabezado de la solicitud. Más información sobre el uso de las claves de las API en HubSpot.
- Si estás solicitando una API de HubSpot:
- Haz clic en el menú desplegable Clave de API y selecciona un secreto. El valor secreto debe tener el formato Bearer [TU_TOKEN].
- Define el valor del nombre de la clave de la API como Autorización.
- Define el valor Ubicación de la clave de la API como Encabezado de la solicitud.
-
-
- Para utilizar una propiedad de HubSpot como parámetro de consulta:
- En la sección Parámetros de consulta, introduce la Clave y luego selecciona una propiedad.
- Para agregar otra propiedad, haz clic en Agregar propiedad.
- Para eliminar una propiedad, haz clic en el icono de la papelera delete.
- Para utilizar un valor estático como parámetro de consulta:
- En la sección Parámetros de consulta , introduce el interruptor , y luego introduce un valor.
- Para añadir otra propiedad, haz clic en Añadir valor estático.
- Para eliminar una propiedad, haz clic en el icono de la papelera delete.
- Haz clic en Guardar.
Prueba tu webhook en HubSpot
Al configurar un webhook POST o GET, puedes ejecutar una prueba para ver su respuesta. Durante la prueba, mientras se envían y recuperan datos de un tercero, los registros existentes en HubSpot no se verán afectados. Si estás utilizando una clave de API para la autenticación, esa clave no se mostrará en ninguna solicitud de prueba.
Después de probar el webhook, puedes seleccionar los campos que se utilizarán como entradas más adelante. Selecciona solo las salidas disponibles en cada respuesta. Si la salida se utiliza en una acción posterior, pero no está disponible en la respuesta, la acción fallará.
- En tu cuenta de HubSpot, dirígete a Automatizaciones > Workflows.
- Clic en el nombre del workflow.
- En el Editor de workflow, haz clic en la acción Enviar un webhook.
- En el panel izquierdo, haz clic en Probar acción para ampliar la sección.
- Si estás probando una solicitud POST, haz clic en el menú desplegable [objeto], y selecciona un registro de con el que hacer la prueba.
- Haz clic en Probar.
- Para comprobar los detalles del webhook, selecciona la pestaña Respuesta o Solicitud. En cada pestaña, puedes hacer clic en Abrir todo, para ampliar todas las secciones, o en Contraer todo para contraer todas las secciones
- En la pestaña Respuesta, haz clic en encabezados: o en cuerpo: para ampliar cada sección.
- En la pestaña Solicitud, haz clic en httpHeaders: para ampliar la sección
Probar un webhook en un entorno externo
Después de crear un workflow con una acción de webhook, puedes ejecutar una prueba rápida con una URL de webhook ficticia:
- En el navegador, ve a https://webhook.site y copia la URL única.
- En el campo URL de webhook de la acción del webhook, pega la URL.
- Una vez activado tu workflow, puedes Inscribir manualmente un contacto de prueba.
- Cuando pruebes tu webhook externamente:
- Cuando se desencadene la acción del webhook, se enviará a ese webhook un cuerpo de respuesta JSON que contiene toda la información sobre el contacto, incluyendo envíos de formularios, pertenencia a listas y todos los valores de las propiedades de ese contacto. El sistema de recepción puede analizar los datos JSON y usarlos en su propia aplicación.
- Si se desencadena una acción de webhook con una solicitud GET, se enviará una solicitud GET genérica, a menos que se hayan aplicado parámetros de consulta adicionales.
Nota: los valores anteriores de las propiedades solo se devolverán en workflows basados en contactos. Los webhooks utilizados en el resto de tipos de workflows solo devolverán el valor más reciente.
Verificar la solicitud de firmas en los webhooks de workflows
Donde seleccionaste Solicitar firma en la sección Autenticación de la acción Desencadenar un webhook, HubSpot rellenará el webhook con un encabezado de firma X-HubSpot que incluye un código hash SHA-256 de la concatenación del secreto de la aplicación, el método HTTP, la URI y el cuerpo sin analizar. Puedes consultar más información a este respecto en la documentación para desarrolladores.
Para verificar que las solicitudes recibidas en la URL son de HubSpot:
- Debes tener una cuenta de desarrollador. Si no la tienes, regístrate para abrir una.
- Debes tener una aplicación. Si no tienes una aplicación, puedes consultar cómo crear una en este recurso para desarrolladores.
- Debes verificar el valor del código hash de la firma.
Desencadenar workflows a partir de webhooks
Los webhooks pueden utilizarse para activar workflows. Cuando los datos cambian en una aplicación de terceros, esto puede desencadenar un workflows. Más información sobre la activación de workflows desde webhooks.
Utilizar datos de webhook en el panel de datos
Los datos del webhook conectado a tu cuenta pueden utilizarse para determinadas acciones en el panel de datos de .
Para utilizar los datos del webhook conectado a :
- En tu cuenta de HubSpot, dirígete a Automatizaciones > Workflows.
- Haz clic en el nombre de tu workflow.
- Haz clic en el icono + más para añadir una acción.
- En el panel izquierdo, selecciona una acción que utilice el panel de datos .
- En el panel de datos, haz clic en Ver propiedades o salidas de acciones del menú desplegable y selecciona Activador de webhook. A continuación, puedes utilizar las propiedades del webhook conectado.