Webhooks

¿Que es un Webhook?

Los webhooks le permite a Osigu notificar sobre ciertos eventos en el momento en que están ocurriendo.

Cuando uno de estos eventos sucede, la plataforma envía una solicitud HTTP a servicios que él Payer provee y los cuales deben de coincidir con las especificaciones hechas por Osigu.

Los eventos que reporta la plataforma a través de los webhooks son:

Por supuesto, cada evento tiene un formato especifico con la información que corresponde al evento. Así mismo cada notificación incluye un tipo de evento que puede ser utilizado para identificar el tipo de evento que se está reportando.

¿Qué esperamos de los Webhooks?

Los Webhooks que nos proporcione la aseguradora deben funcionar sobre protocolo HTTPS.

Todas las solicitudes que se realicen de forma exitosa a los webhooks deben de responder un código de HTTP 2xx.

Por lo tanto, cualquier respuesta que sea salga del rango de 200-299 será interpretada como un error en la notificación y entrará al proceso de re-intentos de notificación hasta que el límite de intentos se haya alcanzado. Cada reintento tiene una diferencia de minutos entre si.

Los nombres de los atributos o campos del request body y del response body deben de coincidir con la definición hecha por Osigu.

Seguridad

Se requiere que los servicios que se proporcionen como webhooks para la plataforma incluyan algún mecanismo de seguridad como:

• OAuth2.0 - Client ID + Client Secret para obtener un access token temporal.
• Mutual authentication/2WA por medio de certificados de seguridad.
• API Token con rotación programada de al menos 3 meses.
• Lista blanca de IPs

🚧

Importante

Se pueden configurar dentro de Osigu, URLs que funcionen bajo el protocolo HTTPS. Existen excepciones pero requerirá del uso de una VPN lo cuál podría incrementar el costo de la implementación.