Consulta los conectores compatibles con Application Integration.

Activador de webhook

Vista previa — Webhook trigger

Esta función está sujetas a los "Términos de las Ofertas de Acceso Previo a la Disponibilidad General" de la sección Términos Generales de los Servicios de los Términos Específicos de los Servicios. Las funciones previas a la disponibilidad general están disponibles tal cual y pueden tener una compatibilidad y asistencia limitadas. Para obtener más información, consulta las descripciones de las fases de lanzamiento.

El activador de webhook es un activador de eventos de conector que te permite invocar una integración basada en cualquier evento del backend que admita webhooks. El activador Webhook recibe eventos de aplicaciones SaaS de terceros que admiten la función de eventos de webhook. Este activador admite varios tipos de autenticación para tu receptor de eventos y solo acepta cargas útiles JSON.

Importante: Integration Connectors es un componente facturable de Google Cloud. Para obtener información sobre los costes y los cargos por usar Integration Connectors, consulta los precios de Integration Connectors.

Antes de empezar

Si tienes previsto crear o configurar una conexión para el activador de webhook, asegúrate de que tienes el siguiente rol de Gestión de Identidades y Accesos (IAM) en el proyecto:

• Administrador del conector (roles/connectors.admin)

Para obtener información sobre cómo conceder roles, consulta el artículo sobre cómo gestionar el acceso.

Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el activador de webhook:

• Invocador de integración de aplicaciones (roles/integrations.integrationInvoker)

Para obtener información sobre cómo conceder roles a una cuenta de servicio, consulta el artículo sobre cómo gestionar el acceso a cuentas de servicio.

Añadir el activador de webhook

Para añadir un activador de webhook a tu integración, sigue estos pasos:

1. En la Google Cloud consola, ve a la página Integración de aplicaciones.

   Ir a Application Integration

2. En el menú de navegación, haga clic en Integraciones.

   Aparecerá la página Lista de integraciones, donde se muestran todas las integraciones disponibles en el proyecto de Google Cloud.

3. Seleccione una integración o haga clic en Crear integración para crear una.

   Si vas a crear una integración:

   1. Escribe un nombre y una descripción en el panel Crear integración.
   2. Selecciona una región para la integración.
      Nota: En el menú desplegable Regiones solo se muestran las regiones aprovisionadas en tu proyecto de Google Cloud. Para aprovisionar una región, haz clic en Habilitar región. Para obtener más información, consulta Habilitar una región nueva.
   3. Selecciona una cuenta de servicio para la integración. Puede cambiar o actualizar los detalles de la cuenta de servicio de una integración en cualquier momento desde el panel Resumen de la integración de la barra de herramientas de integración.
      Nota: La opción de seleccionar una cuenta de servicio solo se muestra si ha habilitado la gestión de la integración en la región seleccionada.
   4. Haz clic en Crear.

   La integración que acabas de crear se abre en el editor de integraciones.

4. En la barra de navegación del editor de integraciones, haga clic en Activadores para ver la lista de activadores disponibles.
5. Haz clic en el elemento Activador de webhook y colócalo en el editor de integraciones.

Para configurar el activador de webhook, puedes usar una conexión de webhook que ya tengas en Integration Connectors o crear una con la opción de creación de conexión insertada.

Configurar un activador de webhook con una conexión ya creada

Puedes configurar el activador de webhook con una conexión de webhook que ya tengas en Integration Connectors. Ten en cuenta que el activador de webhook es un activador de evento de conector, por lo que solo puedes usar una conexión de webhook con la suscripción a eventos habilitada para configurar el activador.

Para obtener información sobre cómo configurar un desencadenador de webhook con una conexión de webhook nueva, consulta Configurar un desencadenador de webhook con una conexión nueva.

Para configurar un activador de webhook con una conexión de webhook, sigue estos pasos:

1. En el editor de integraciones, haz clic en el elemento Activador de webhook para abrir el panel de configuración del activador.
2. Haz clic en Configurar activador.
3. En la página Editor de activadores de eventos de conector, proporcione los siguientes detalles de configuración:
   1. Región: selecciona la región de tu conexión Webhook.
   2. Conexión: selecciona la conexión de webhook que quieras usar.

      La integración de aplicaciones solo muestra las conexiones Webhook que están activas y tienen habilitada una suscripción a eventos.

   3. Tipo de suscripción a eventos: introduce el tipo de evento que quieras usar para activar la integración.
   4. Cuenta de servicio: selecciona una cuenta de servicio con los roles de gestión de identidades y accesos necesarios para el activador de webhook.
4. Haz clic en Hecho para completar la configuración del activador y cerrar la página.

Para obtener más información, consulta la documentación sobre la conexión de webhook.

Configurar un activador de webhook con una nueva conexión

Para configurar el activador Webhook con una nueva conexión Webhook, sigue estos pasos:

1. En el editor de integraciones, haz clic en el elemento Activador de webhook para abrir el panel de configuración del activador.
2. Haz clic en Configurar activador.
3. Omite el campo Región.
4. Haga clic en Conexión y seleccione la opción Crear conexión en el menú.
5. Siga estos pasos en el panel Crear conexión:
   1. En la sección Ubicación, elige la ubicación de la conexión.
      1. Región: selecciona una ubicación de la lista.

         Las regiones admitidas para los conectores son las siguientes:

         Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

      2. Haz clic en Siguiente.
   2. En la sección Detalles de la conexión, haz lo siguiente:
      1. Conector: selecciona Webhook en la lista desplegable de conectores disponibles.
      2. Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
      3. Nombre de conexión: introduce un nombre para la instancia de conexión.

         Los nombres de las conexiones deben cumplir los siguientes criterios:

         • Los nombres de conexión pueden contener letras, números o guiones.
         • Las letras deben estar en minúsculas.
         • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
         • Los nombres de conexión no pueden tener más de 49 caracteres.
         • En el caso de los conectores que admiten la suscripción a eventos, los nombres de conexión no pueden empezar por el prefijo "goog".
      4. Descripción: si quieres, escribe una descripción de la instancia de conexión.
      5. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
      6. Suscripción a eventos: la suscripción a eventos estará habilitada de forma predeterminada y es obligatoria para el conector de webhook.
         Nota: La opción Enable event subscription, entity and actions no es compatible con esta conexión.
      7. También puedes hacer clic en + Añadir etiqueta para añadir una etiqueta a la conexión en forma de par clave-valor.
      8. Haz clic en Siguiente.
   3. En la sección Event Subscription Details (Detalles de la suscripción a eventos), haz lo siguiente:
      1. Autenticación del procesador: selecciona un tipo de autenticación para el procesador de eventos e introduce los detalles pertinentes.

         El webhook listener admite los siguientes tipos de autenticación:

         • Sin autenticación
         • Autenticación de Google: asegúrate de que la cuenta de servicio tenga el rol roles/connectors.listener, cuyo token de acceso se usa para la autenticación.
         • Autenticación con clave de API
         • Autenticación básica
      2. Ubicación del campo Tipo de evento: campo obligatorio que indica la ubicación (encabezado, parámetro de consulta o cuerpo de la solicitud) en la que se encontrará el tipo de evento asociado a la solicitud de evento entrante.
      3. Nombre del campo de tipo de evento: campo obligatorio en la ubicación configurada que identifica el tipo de evento asociado a la solicitud de evento entrante.

      {
      "event_type": "user.created",
      ...
      // other request fields
      ...
      }

      En el ejemplo anterior, el campo event_type del cuerpo de la solicitud indica que la solicitud se refiere a un evento "user.created".
      4. Selecciona Habilitar conectividad privada para establecer una conexión segura entre tu aplicación backend y tu conexión. Si seleccionas esta opción, debes seguir unos pasos de configuración adicionales después de crear la conexión. Para obtener más información, consulta Conectividad privada para la suscripción a eventos.
      5. Introduce la configuración de la cola de mensajes fallidos. Si configura mensajes fallidos, la conexión escribe los eventos no procesados en el tema de Pub/Sub especificado. Introduzca los siguientes detalles:
         1. ID de proyecto de mensajes fallidos: el ID del proyecto de Google Cloud en el que has configurado el tema de mensajes fallidos de Pub/Sub.
         2. Tema de mensajes fallidos: el tema de Pub/Sub en el que quieres escribir los detalles del evento no procesado.
      6. Haz clic en Siguiente.
   4. Revisar: revisa los detalles de la conexión y la autenticación del receptor.
   5. Haz clic en Crear.

Salida del activador

El activador de webhook tarda un par de minutos en completar la configuración de la suscripción al evento. Puedes ver el estado de tu suscripción a eventos en el panel de configuración de activadores, en Detalles de la suscripción a eventos.

El activador de webhook indica el estado de una suscripción a eventos mediante los siguientes estados:

• Creating: indica que el activador se está suscribiendo a la suscripción al evento.
• Active: indica que el activador se ha suscrito correctamente a una suscripción de evento.
• Error: indica que hay un problema con la suscripción a eventos configurada.

Además del estado de la suscripción a eventos, en la sección Detalles de la suscripción a eventos también se muestran otros detalles, como la región de la conexión, el nombre de la conexión, el nombre de la suscripción a eventos y más.

Variable de salida del activador

Por cada evento, el activador de webhook genera una variable de salida ConnectorEventPayload que puedes usar en las tareas posteriores. La variable de salida está en formato JSON y contiene el esquema de la carga útil del webhook de salida. El activador de webhook solo acepta cargas útiles JSON.

Ver suscripciones a eventos

Para ver y gestionar todas las suscripciones a eventos asociadas a una conexión en Integration Connectors, sigue estos pasos:

1. Ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones).

   Ve a la página Conexiones

2. Haz clic en la conexión de la que quieras ver las suscripciones.
3. Haz clic en la pestaña Suscripciones a eventos.

   Se muestran todas las suscripciones a eventos de la conexión.

Editar un activador de webhook

Puedes editar un activador de webhook para cambiar o actualizar la configuración de la conexión y los detalles de la suscripción al evento.

Importante: Cuando editas o modificas un activador de webhook, puedes conservar la suscripción a eventos configurada anteriormente que está asociada al activador o eliminarla. Si eliminas una suscripción a eventos, se verán afectadas todas las integraciones publicadas que la usen.

Para editar un activador de webhook, sigue estos pasos:

1. En el editor de integraciones, haz clic en el elemento Activador de webhook para abrir el panel de configuración del activador.
2. Haz clic en Configurar activador de webhook.
3. En la página Editor de activadores de eventos de conector, haz lo siguiente:
   1. Para conservar la suscripción al evento configurada anteriormente, haga clic en Conservar. De lo contrario, haga clic en Eliminar.
      Advertencia: Si elimina una suscripción a un evento, afectará a todas las integraciones publicadas que la usen. Esta tarea no se puede deshacer.
   2. Actualiza la configuración de la conexión y los detalles de la suscripción a eventos como quieras.
   3. Haz clic en Listo.

Puedes ver los detalles actualizados de la conexión y de la suscripción a eventos en el panel de configuración del activador, en Detalles de la suscripción a eventos.

Cuotas y límites

Para obtener información sobre las cuotas y los límites, consulta Cuotas y límites.

Siguientes pasos

• Consulta información sobre todas las tareas y los activadores.
• Consulta cómo probar y publicar una integración.
• Consulta información sobre el tratamiento de errores.
• Consulta información sobre los registros de ejecución de integraciones.