Webhook
El conector Webhook te permite monitorizar eventos de tu backend que admite webhooks. Este conector se ha diseñado para usarse con el activador de webhook. 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 procesador de eventos. Para usar el activador de webhook en tu integración, primero debes configurar un conector de webhook.
Antes de empezar
Antes de usar el conector Webhook, haz lo siguiente:
- En tu proyecto de Google Cloud:
- Habilita los siguientes servicios:
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Para saber cómo habilitar servicios, consulta Habilitar servicios.
- Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.
Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.
- Habilita los siguientes servicios:
Configurar el conector
Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:
- En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.
- Haga clic en + Crear para abrir la página Crear conexión.
- En la sección Ubicación, elige la ubicación de la conexión.
- Región: selecciona una ubicación de la lista desplegable.
Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.
- Haz clic en Siguiente.
- Región: selecciona una ubicación de la lista desplegable.
- En la sección Detalles de la conexión, haz lo siguiente:
- Conector: selecciona Webhook en la lista desplegable de conectores disponibles.
- Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
- 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".
- Descripción: si quieres, escribe una descripción de la instancia de conexión.
- Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
- Suscripción a eventos: la suscripción a eventos estará habilitada de forma predeterminada y es obligatoria para el conector de webhook.
- También puedes hacer clic en + Añadir etiqueta para añadir una etiqueta a la conexión en forma de par clave-valor.
- Haz clic en Siguiente.
-
En la sección Event Subscription Details (Detalles de la suscripción a eventos), haz lo siguiente:
- 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
- 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.
- 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.
- 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.
- 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:
- 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.
- Tema de mensajes fallidos: el tema de Pub/Sub en el que quieres escribir los detalles del evento no procesado.
- Haz clic en Siguiente.
En el ejemplo anterior, el campo event_type del cuerpo de la solicitud indica que la solicitud se refiere a un evento "user.created".{ "event_type": "user.created", ... // other request fields ... }
- Autenticación del procesador: selecciona un tipo de autenticación para el procesador de eventos e introduce los detalles pertinentes.
- Revisar: revisa los detalles de la conexión y la autenticación del receptor.
- Haz clic en Crear.
Usar la conexión Webhook en una integración
Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.
- Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
- Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.
Obtener ayuda de la comunidad de Google Cloud
Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.Siguientes pasos
- Consulta cómo suspender y reanudar una conexión.
- Consulta cómo monitorizar el uso de los conectores.
- Consulta cómo ver los registros de conectores.