Introducción

Los webhooks le permiten enviar datos en tiempo real a cualquier otra plataforma que esté utilizando. Éstos se disparan al ocurrir un evento determinado, por ejemplo, al finalizar la inscripción de un alumno.

Debéra elegir a qué eventos quiere subscribirse para enviar los datos a a la URL que especifique. De esta manera, sabremos cuándo debemos enviar los datos y a dónde.

Para usar este módulo deberá tener el siguiente permiso:

8700 - Permite al usuario la completa gestión de los webhooks (agregar, quitar y ver)

IMPORTANTE: El cliente es dueño de sus datos y se responsabiliza del tratamiento y divulgación de los mismos al procesar las solicitudes. 

IMPORTANTE: Para comprender y hacer uso de los webhooks es necesario tener un conocimiento intermedio de desarrollo y manejo de solicitudes HTTP.

Requerimientos

Algunas cosas a tener en cuenta al configurar y trabajar con webhooks:

Las URL pueden ser HTTP o HTTPS. En caso de usar HTTPS debe asegurarse que su servidor tenga configurado e instalado un certificado SSL válido.

Su servidor debe ser capaz de procesar la solicitud en menos de 10 segundos. Si no recibimos una respuesta, el webhook expirará y la conexión se cerrará.

Para confirmar que se recibe un webhook, su terminal debe devolver uno de los siguientes códigos de estado HTTP 2xx:

El cuerpo de la respuesta debe contener el JSON: {"status": "ok"} para que el webhook no se vuelva a enviar nuevamente.

IMPORTANTE: En la plataforma de TEST los webhooks no se envían automáticamente. Deberá lanzarlos de forma manual. Para más información: Envío manual.

Autenticación

Para verificar que el envío de datos proviene de Quinttos, puede agregar su propio código interno de seguridad al webhook. Esto le permitirá aceptar solo las solicitudes que contengan el código interno de seguridad especificado.

El código interno de seguridad se envía como un encabezado en la solicitud HTTP con el nombre X-Secret al invocar la URL del webhook. Un ejemplo de un encabezado es el siguiente:

Content-Type: application/json
X-Webhook-Event: enrollment_added
X-Webhook-ID: dd7145e0-0fc4-439e-a890-a10b1fce0ceb
X-Request-ID: 23ecbdd3-c6dd-479e-a72b-9f68811a9f63
X-Secret: dsdiq32i4dma1

Política de reintento

Si la solicitud del webhook falla debido a un problema con la red o el servidor, se volverá a intentar en un total de 5 veces.

Solicitudes que se vuelven a intentar

Se vuelven a enviar los webhook en los siguientes casos:

Características

Todos los webhooks tienen las siguientes características:

Webhook headers

Cada solicitud tendrá los siguientes encabezados: