Configurar webhooks

Configura webhooks en Logto Console para lograr una integración fluida y recibir notificaciones de eventos en tiempo real para tu aplicación. Disfruta de una configuración sencilla, mayor seguridad y opciones convenientes de monitoreo de estado.

Crear un webhook

Primero, crea un endpoint de webhook que será llamado por el Logto Agent. Este endpoint debe estar implementado en tu servidor y ser capaz de recibir solicitudes HTTP.

Para crear un nuevo webhook en Logto Console, sigue estos pasos:

1. Crear webhook: Navega a Consola > Webhooks y haz clic en el botón "Crear webhook".

2. Nombre: Proporciona un nombre para el webhook. Es solo para tu referencia y para definir el escenario de uso.

3. Endpoint URL: Ingresa la Endpoint URL, que es la URL de tu servidor que recibirá las solicitudes POST del webhook cuando ocurra el evento. Por razones de seguridad, la URL debe ser accesible públicamente a través de HTTPS y no debe ser una URL de localhost.

   nota:

   Tu servidor debe responder a las solicitudes de webhook de Logto con una respuesta HTTP 200 ("OK") inmediatamente después de recibir la solicitud para notificar que la solicitud ha sido recibida.

   Esperar a que se complete el procesamiento lógico del evento del Webhook antes de responder podría causar que el Webhook exceda el tiempo de espera.

   No devuelvas ninguna respuesta distinta de 200 al webhook de Logto. Si ocurre un error al procesar el evento, manéjalo en tu propio servidor.

4. Evento: En la ventana modal que aparece, selecciona los eventos deseados que activarán este webhook. Se recomienda elegir un número reducido de eventos que cumplan con tus requisitos para evitar saturar la recepción del servidor. Puedes cambiar los eventos seleccionados en cualquier momento después de crear el webhook.

   

5. Desactivar / Reactivar: Por defecto, el webhook se activa inmediatamente después de su creación. Si deseas suspender temporalmente el webhook, puedes desactivarlo o reactivarlo usando el menú de "Tres puntos" ubicado en la esquina superior derecha del encabezado después de crearlo.

Proteger el webhook

Una vez que tu servidor esté listo para recibir solicitudes de webhook, es posible que desees asegurarte de que pueda manejar las solicitudes de forma segura. Logto genera una firma para cada carga útil de solicitud de webhook, lo que te permite verificar que la solicitud proviene de Logto.

Después de crear un nuevo webhook, tienes opciones para mejorar su seguridad:

• Clave de firma: Logto genera una firma hash única, conocida como Clave de Firma, para cada webhook. Puedes incluir esta clave como un encabezado de solicitud en la implementación de tu endpoint. Verificar la clave de firma asegura que la carga útil del webhook proviene de Logto y no ha sido manipulada por fuentes no autorizadas. Lee cómo proteger tus webhooks para aprender más sobre el código.
• Encabezado personalizado: Tienes la opción de incluir encabezados personalizados en la carga útil del webhook para proporcionar contexto o metadatos adicionales. Esta función te permite agregar información relevante que puede ayudar a procesar los datos del webhook de manera efectiva.

Al utilizar la Clave de Firma y considerar la inclusión de Encabezados Personalizados, puedes mejorar la seguridad de tus webhooks y garantizar la integridad y autenticidad de las cargas útiles recibidas.

Probar el webhook

Para probar la conexión entre Logto y tus servicios, simplemente haz clic en el botón "Enviar carga de prueba". Logto enviará una carga de ejemplo para cada evento seleccionado a tu Endpoint URL. Estas solicitudes de prueba contienen datos anónimos y no se registran en el historial de solicitudes recientes.

Esta prueba asegura que tu webhook esté correctamente configurado para recibir y procesar cargas útiles de Logto. Te permite validar la integración antes de desplegar el webhook en un entorno en vivo.

Monitorear el estado de salud del Webhook

Logto proporciona herramientas convenientes para monitorear el estado de salud de tus webhooks e investigar cualquier posible problema en detalle:

• Estado de salud La lista de webhooks en Logto muestra el estado de salud de cada webhook, incluyendo la tasa de éxito y el número total de solicitudes realizadas en las últimas 24 horas. Esta información te da una visión general del rendimiento del webhook.
• Registros de solicitudes independientes En la sección "Solicitudes recientes" de cada webhook, puedes acceder a los registros de solicitudes de las últimas 24 horas. Cada solicitud se registra individualmente, lo que te permite ver los detalles de cada solicitud e investigar posibles errores o anomalías.
• Reintento automático En caso de una entrega fallida (cuando el estado de respuesta del webhook es mayor o igual a 500), Logto reintenta automáticamente la entrega hasta tres veces. Ten la seguridad de que varios reintentos de la misma solicitud solo generarán una sola entrada en el registro, evitando duplicaciones innecesarias. Todos los reintentos de una solicitud llevan el mismo deliveryId en la carga útil, por lo que tu endpoint puede omitir una entrega que ya haya procesado.

Al aprovechar estas funciones de monitoreo, puedes rastrear eficazmente la salud de tus webhooks, examinar los registros de solicitudes y garantizar la fiabilidad y el rendimiento de tus integraciones de webhook.