Los webhooks poseen la finalidad de realizar notificaciones de eventos sobre una entidad. Por consecuencia, se notifica la creación, actualización o eliminación de un elemento o entidad a un endpoint configurado en la aplicación del consumidor.
Interacción
Por cada movimiento realizado en la entidad, se emitirá una respuesta a un servicio/endpoint definido en la aplicación disponible encontrada.
En casos donde el servicio no se encuentre disponible se realizarán reintentos en distintos lapsos de tiempo hasta darse como desestimada la notificación.
En casos exitosos, el estado HTTP a responder debe ser 200 (success) ó 201 (created). No se analiza información extra en la respuesta y en el transcurso podrá desencadenar los procesos que necesite por su parte. Por ejemplo: consumir otro servicio o notificar un CMR.
Importante: la edición de un legajo desde API no provoca la emisión de un webhook. Únicamente interacciones desde los flujos de usuario u operaciones desde el backoffice.
Reintentos
A continuación se definen los lapsos de tiempos de reintentos en caso de que la respuesta no haya sido exitosa:
-
5 minutos
-
45 minutos
-
6 horas
-
2 días
-
4 días
Una respuesta errónea puede darse como cualquier respuesta distinta de 200, 201.
Los tiempos son contados como referencia desde la primera emisión, no de forma creciente. Los intentos reiterados son por notificación emitida.
Ejemplo de body emitido
Método: POST
{
"entity": "legajo",
"applicationId": "5f203f4a8e8f7e001b04f3c5",
"tenant": "5c0528ab24aa9a0001cb3dd6",
"action": "legajo.updated",
"createdAt": "2020-08-18T16:53:31.614Z",
"data": {
"_id": "5f2d8e202afdfa0011542c74",
"typeScoring": "Directo",
"totalComplete": 100,
"status": "Nuevo"
}}
Ejemplo de notificación que recibirás en el body a tu servidor.