Webhook

El conector de webhook te permite escuchar eventos desde tu backend. Este conector está diseñado para usarse con el activador de webhook. Para usar el activador de webhook en tu integración, primero debes configurar un conector de webhook.

Antes de comenzar

Antes de usar el conector de webhook, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    • Otorga los siguientes roles de IAM a la cuenta de servicio que quieres usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano. Estas cuentas deben autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

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

    2. Haz clic en Siguiente.
  4. 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.
    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.
  5. 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:

    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.
      4. {
"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.
  6. Revisión: Revisa los detalles de autenticación de tu conexión y objeto de escucha.
  7. Haz clic en Crear.

Usa la conexión de webhook en una integración

Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?