Definiciones

Un webhook es el mecanismo que nos permite notificar a tu servidor sobre una acción específica ocurrida en Skualo y generar una reacción en tu aplicación para que esta tome las acciones necesarias al respecto.

Las notificaciones enviadas por Skualo son objetos tipo Evento que contienen toda la información relevante sobre lo que ha ocurrido. El webhook endpoint debería utilizar esta información para realizar cualquier acción necesaria que permita mantener el estado correcto en tu aplicación.

{
    "tipoEvento": "DOCUMENTO_UPDATED",
    "identificador": "9f077032-f346-495d-8008-005a9449950c"
}

Consideraciones claves

Por cada evento que ocurra en Skualo, se envía una petición HTTPs (POST) en formato JSON a los webhook endpoints registrados.

Como mínimo, tu webhook endpoint debe ser capaz de recibir peticiones POST, para obtener la información de un evento, y confirmar la recepción respondiendo con cualquier código HTTP perteneciente a la familia de estados exitosos (2xx).

Retornar 2xx rápidamente

Para confirmar que se recibió un evento correctamente, tu aplicación debe responder con un estado HTTP 2xx. Ante cualquier respuesta fuera de este rango, se considerará que el evento no fue recepcionado de manera correcta.

Es de gran importancia retornar el estado de recepción del webhook lo más pronto posible. Cualquier lógica compleja de tu aplicación motivada por la recepción del webhook, deberá ser realizada de forma asíncrona.

❗️

IMPORTANTE!

Si una notificación Webhook falla, se volverá a intentar un máximo de 10 veces.

Tipos de Eventos

Hasta este momento estos son los tipos de eventos que se están notificando a través de Webhooks.