Saltar al contenido principal

Configurar webhooks

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

Crear un webhook​

Primero, crea un endpoint de webhook que será llamado por el Logto Agent. Este endpoint debe ser 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 Console > Webhooks y haz clic en el botón "Create webhook".

  2. Nombre: Proporciona un nombre para el webhook. Es para tu propia referencia 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 host local.

    nota

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

    Esperar a que se complete el procesamiento de la lógica del evento del Webhook correspondiente antes de responder podría causar que el Webhook se agote.

    No devuelvas ninguna respuesta que no sea 200 al webhook de Logto. Si ocurre un error mientras se procesa el evento, manéjalo en tu propio servidor.

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

    Crear webhook

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

Asegurar 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 manera 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 la 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 se origina en Logto y no ha sido manipulada por fuentes no autorizadas. Lee asegurando 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 asegurar 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 "Send test payload". Logto enviará entonces una carga útil de muestra para cada evento seleccionado a tu URL de endpoint. 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é configurado correctamente para recibir y procesar cargas útiles de Logto. Te permite validar la integración antes de implementar 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 problema potencial 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 "Recent Requests" 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 cualquier error o anomalía potencial.
  • 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 múltiples reintentos de la misma solicitud solo generarán una sola entrada de registro, evitando duplicaciones innecesarias.

Al aprovechar estas características de monitoreo, puedes rastrear efectivamente la salud de tus webhooks, examinar los registros de solicitudes y asegurar la confiabilidad y el rendimiento de tus integraciones de webhook.