Webhooks de usuarios

En INTEGRADOC puedes compartir la información sobre eventos que suceden sobre tus usuarios con sistemas externos a través de webhooks.
Los webhooks proporcionan un mecanismo para notificar a tu aplicación cuando se produzca un determinado evento que afecta a un usuario y así poder tomar acciones.

En INTEGRADOC hay varios eventos que pueden ser tomados en cuenta al momento de configurar los webhooks de usuario:

Cuando un usuario es invitado a INTEGRADOC
Cuando un usuario acepta la invitación y se transforma en usuario activo.
Cuando se desususcribe un usuario de los mails.
Cuando el usuario es borrado.
Cuando se modifica el usuario nombre o alias.
Cuando se agrega, modifica o quita la suplencia.
Cuando el usuario se loggea en INTEGRADOC.

Las acciones en tu sistema dependerán de lo que desees y deberás configurar la URL para ejecutarla.

¿Cómo funcionan los webhooks?

Imagina un sistema de timbre, el mismo incluye un botón en la puerta y una campana en tu sala de estar.
Cuando una persona presiona el botón, suena la campana en la sala, lo que te informa que alguien está en la puerta - es decir, una señal es enviada desde el botón al timbre.
En este ejemplo: alguien llegará a la puerta y presionará el botón, la campana escuchará el botón y sonará.

Los Webhooks funcionan de la misma manera, la puerta será INTEGRADOC, el botón será el evento que sucede en INTEGRADOC y la campana el sistema al cual notificarás de ese evento.
Para los webhooks: Sucederá un evento asociado a un usuario en INTEGRADOC, el otro sistema escuchará ese evento y realizará una acción en base a ello, por ejemplo Actualizar datos.

Webhook: user:create

Un webhook configurado para el evento user:create será ejecutado al momento de que un usuario sea invitado a INTEGRADOC.

El formato para cada Json enviado al servicio es el siguiente:



Alias es el email alias que defina el usuario en su perfil.

Webhook: user:update

Un webhooks configurado para el evento user:update será ejecutado en caso de que alguna de las siguientes acciones sucedan:
Cuando un usuario acepta la invitación y se transforma en usuario activo.
Cuando se desususcribe un usuario de los mails.
Cuando el usuario es borrado.
Cuando se modifica el usuario nombre o alias.

El formato para cada Json enviado al servicio es el siguiente:

WebHook user:out-of-office

Un webhook configurado para el evento user:out-of-office será ejecutado al momento de que se agregue, modifique o quite la suplencia de un usuario.

El formato para cada Json enviado al servicio es el siguiente:



Cuando se elimina una suplencia se debe enviar el payload con action Deleted y con los datos de substitute, start y end como strings vacios. En el caso de ser modificada la suplencia el action es Updated.

WebHook user:login

Un webhook configurado para el evento user:login será ejecutado al momento de que un usuario se loggea en INTEGRADOC.

El formato para cada Json enviado al servicio es el siguiente:

Configurar webhooks

Los webhooks de usuario deben ser configurados desde la sección Configuración Avanzada .








Ten en cuenta que en tu implementación debes controlar que un dato proveniente de un reintento no sobreescriba un dato posterior de la misma instancia, controlando el timestamp del evento.

Actualizado el: 16/09/2020