Consulta los conectores compatibles para Application Integration.

Activador de webhook

Vista previa — Webhook trigger

Esta función está sujeta a las "Condiciones de las Ofertas de Fase Previa a la DG" de la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de fase previa a la DG están disponibles “tal cual” y podrían tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

El activador de webhook es un activador de evento de conector que te permite invocar una integración en función de cualquier evento que admita webhooks.

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

Antes de comenzar

Si planeas crear o configurar una conexión nueva para el activador de webhook, asegúrate de tener el siguiente rol de Identity and Access Management (IAM) en el proyecto:

• Administrador de conectores (roles/connectors.admin)

Para obtener información sobre cómo otorgar roles, consulta Administra el acceso.

Otorga los siguientes roles de IAM a la cuenta de servicio que quieres usar para el activador de webhook:

• Invocador de Application Integration (roles/integrations.integrationInvoker)

Para obtener información sobre cómo otorgar roles a una cuenta de servicio, consulta Administra el acceso a las cuentas de servicio.

Agrega el activador de webhook

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

1. En la consola de Google Cloud, ve a la página Application Integration.

   Ir a Application Integration

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

   Aparecerá la página Integrations List (Lista de integraciones) y aparecerá una lista de todas las integraciones disponibles en el proyecto de Google Cloud.

3. Selecciona una integración existente o haz clic en Crear integración para crear una nueva.

   Si creas una integración nueva, haz lo siguiente:

   1. Ingresa un nombre y una descripción en el panel Create Integration.
   2. Selecciona una región para la integración.
      Nota: En el menú desplegable Regiones, solo se enumeran las regiones aprovisionadas en el proyecto de Google Cloud. Para aprovisionar una región nueva, haz clic en Habilitar región. Consulta Habilita una región nueva para obtener más información.
   3. Selecciona una cuenta de servicio para la integración. Puedes 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 en la barra de herramientas de integración.
      Nota: La opción de seleccionar una cuenta de servicio solo se muestra si habilitaste la administración de integraciones para la región seleccionada.
   4. Haz clic en Crear.

   Esto abrirá la integración en la página del editor de integración.

4. En la barra de navegación del editor de integración, haz clic en Activadores para ver la lista de activadores disponibles.
5. Haz clic y coloca el elemento Activador de webhook en el editor de integración.

Para configurar el activador de webhook, puedes usar una conexión de webhook existente disponible en Integration Connectors o crear una conexión de webhook nueva con la opción de creación de conexión intercalada.

Configura el activador de webhook mediante una conexión existente

Puedes configurar el activador de webhook mediante una conexión de webhook existente 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 que tenga habilitada la suscripción a eventos para configurar el activador.

Si quieres obtener información para configurar un activador de webhook con una conexión de webhook nueva, consulta Configura un activador de webhook mediante una conexión nueva.

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

1. Haz clic en el elemento Activador de webhook en el editor de integración para abrir el panel de configuración del activador.
2. Haz clic en Configurar activador.
3. Proporciona los siguientes detalles de configuración en la página Editor del activador de eventos del conector:
   1. Región: Selecciona la región de la conexión de webhook.
   2. Conexión: Selecciona la conexión de webhook que deseas usar.

      Application Integration solo muestra las conexiones de webhook que están activas y tienen una suscripción a eventos habilitada.

   3. Tipo de suscripción al evento: Ingresa el tipo de evento que deseas usar para activar la integración.
   4. Cuenta de servicio: Selecciona una cuenta de servicio con los roles de IAM necesarios para el activador de webhook.
4. Haz clic en Listo 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.

Configura el activador de webhook mediante una conexión nueva

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

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

         Entre las regiones admitidas para los conectores, se incluyen las siguientes:

         Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

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

         Los nombres de las conexiones deben cumplir con los siguientes criterios:

         • Los nombres de las conexiones pueden usar letras, números o guiones.
         • Las letras deben estar en minúsculas.
         • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
         • Los nombres de las conexiones no pueden superar los 63 caracteres.
      4. Descripción: De forma opcional, ingresa una descripción para 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. De manera opcional, haz clic en + Agregar etiqueta (+ Add label) para agregar 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, completa lo siguiente:
      1. Autenticación del objeto de escucha: Selecciona un tipo de autenticación para el objeto de escucha de eventos y, luego, ingresa los detalles relevantes.

         El objeto de escucha de webhook admite los siguientes tipos de autenticación:

         • Sin autenticación
         • Autenticación de Google: Asegúrate de que la cuenta de servicio tenga la función roles/connectors.listener cuyo token de acceso se usa para la autenticación.
         • Autenticación de la clave de API
         • Autenticación básica
      2. Ubicación del campo de tipo de evento: Es un campo obligatorio que denota la ubicación (encabezado, parámetro de consulta o cuerpo de la solicitud) en la que estará presente el tipo de evento asociado con la solicitud de evento entrante.
      3. Nombre del campo Tipo de evento: El campo obligatorio en la ubicación configurada identifica el tipo de evento asociado con 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 pertenece a un evento "user.created".
      4. Selecciona Habilitar conectividad privada para una conectividad segura entre la aplicación de backend y la conexión. Si seleccionas esta opción, debes realizar pasos de configuración adicionales después de crear la conexión. Para obtener más información, consulta Conectividad privada para suscripciones a eventos.
      5. Ingresa la configuración de mensajes no entregados. Si configuras los mensajes no entregados, la conexión escribe los eventos no procesados en el tema de Pub/Sub especificado. Ingresa los siguientes detalles:
         1. ID del proyecto de mensajes no entregados: Es el ID del proyecto de Google Cloud en el que configuraste el tema de mensajes no entregados de Pub/Sub.
         2. Tema de mensajes no entregados: es el tema de Pub/Sub en el que deseas escribir los detalles del evento sin procesar.
      6. Haz clic en Siguiente.
   4. Revisión: Revisa los detalles de autenticación de tu conexión y objeto de escucha.
   5. Haz clic en Crear.

Resultado del activador

El activador de webhook tarda unos minutos en completar la configuración de suscripción al evento. Puedes ver el estado de tu suscripción al evento en el panel de configuración del activador en Event Subscription details.

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

• Creating: Indica que el activador se suscribe a la suscripción del evento.
• Active: Indica que el activador se suscribió correctamente a una suscripción de evento.
• Error: Indica que hay un problema con la suscripción al evento configurada.

Además del estado de suscripción al evento, la sección Event Subscription details también muestra otros detalles, como la región y el nombre de la conexión, el nombre de la suscripción al evento, etc.

Activa la variable de salida

Para cada evento, el activador de webhook genera una variable de salida ConnectorEventPayload que puedes utilizar en tus tareas downstream. La variable de salida está en formato JSON y contiene el esquema de carga útil de webhook de salida.

Ver suscripciones a eventos

Para ver y administrar todas las suscripciones a eventos asociadas con una conexión en Integration Connectors, haz lo siguiente:

1. Ve a la página Integration Connectors > Connections.

   Ir a la página Conexiones

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

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

Editar 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 al evento configurada anteriormente que se adjuntó al activador o borrarla. Si borras una suscripción a un evento, se verán afectadas todas las integraciones publicadas que usan esa suscripción.

Para editar un activador de webhook, sigue estos pasos:

1. Haz clic en el elemento Activador de webhook en el editor de integración para abrir el panel de configuración del activador.
2. Haz clic en Configurar activador de webhook.
3. Haz lo siguiente en la página Editor del activador de evento del conector:
   1. Para conservar la suscripción a eventos configurada previamente, haz clic en Retención; de lo contrario, haz clic en Borrar.
      Advertencia: Si borras una suscripción a un evento, se verán afectadas todas las integraciones publicadas que usan la suscripción al evento. No se puede deshacer esta tarea.
   2. Actualiza la configuración de la conexión y los detalles de la suscripción al evento como desees.
   3. Haz clic en Listo.

Puedes ver los detalles actualizados de la conexión y suscripción al evento en el panel de configuración del activador, en Event Subscription details.