Los webhooks en Cezanne permiten integrar en tiempo real información clave con otras plataformas. Por ejemplo, cuando en Cezanne haya un cambio en el registro la dirección de un empleado, un webhook notificará automáticamente a la plataforma con la que esté integrada (a veces conocida como punto final). Este tipo de evento (cuando se edita un campo) y también cuando se añaden o eliminan registros, se dividen en categorías según el tipo de registro y se conocen como triggers/factores desencadenantes en el sistema.
Para usar webhooks, es necesario configurar un webhook para cada plataforma o punto final y habilitar los activadores específicos que activarán el webhook.
Este artículo explica cómo configurar y activar webhooks:
Añadir un nuevo Webhook
Navega a: Administración >> Configuración y Seguridad >> Integraciones >> Webhooks.
- Haz clic en Insertar en la parte inferior de la pantalla:
-
- Puedes especificar para qué se utilizará el webhook, por ejemplo, el nombre de la plataforma a la que se enviará el webhook.
3. Introduce la URL del punto final del webhook (debe ser un enlace HTTPS).
4. Introduce una Authentication Key, o genera una aleatoria usando el botón Generar.-
- Esto se usará como una verificación para la aplicación que recibe los datos.
5. (Opcional) marca la casilla de Suspendido si quieres suspender temporalmente el uso del webhook.
-
- Una vez hayas configurado el webhook, siempre que quieras podrás suspenderlo marcando la casilla.
- Si el webhook está suspendido, siempre que quieras podrás desmarcar la misma casilla para volver a habilitarlo.
Configura los factores desencadenantes de un Webhook
Después de haber configurado y guardado los Detalles del Webhook, la pestaña de Factores desencadenantes aparecerá:
Los triggers definen qué acciones o eventos activarán su webhook. Hay 9 tipos, cada uno de los cuales corresponde a un registro dentro de Cezanne. Si se habilita un trigger, el webhook se iniciará cuando su registro correspondiente se haya insertado, actualizado o eliminado en el sistema.
Por ejemplo: si el trigger 'Direcciones' está habilitado y se actualiza un registro de Dirección, los datos para el cambio se enviarán automáticamente a su punto final a través de su webhook.
Habilitar triggers/factores desencadenantes
Para habilitar triggers/factores desencadenantes de Direcciones, Detalles Bancarios, Comunicados, Estado Marital, Detalles de la persona y Actividades de desarrollo de la persona:
- Haz clic sobre un factor desencadenante para abrir el desplegable (ejemplo: Direcciones).
- Marca la casilla Habilitar.
- Haz clic en Guardar y cerrar.
Nota:
- Ausencias, Personal saliente y Nuevas contrataciones requieren pasos extra. Consulta las siguentes secciones para más información.
Configuración factores desencadenantes/triggers de ausencias
Al habilitar el trigger de ausencias, se brindan más opciones de configuración para restringir qué tipos de ausencias pueden activar el webhook y cuándo.
Para habilitar el trigger de Ausencias tienes que:
- Marca la casilla Habilitar.
- Marca al menos una Categoría.
- Marca al menos un Estado.
- Haz clic en Guardar y cerrar.
Por ejemplo, si desea habilitar activadores para vacaciones aprobadas y ausencias por enfermedad,
marcaría las casillas Habilitado, Vacaciones, Enfermedad y Aprobado:
Esta configuración significaría que cada vez que se aprobara una solicitud de vacaciones o enfermedad o se editara un registro de vacaciones o enfermedad aprobado, el webhook se activaría automáticamente.
Nota:
- Para habilitar el trigger de todas las Ausencias, hay marcar todas las casillas disponibles.
- Recibirás el siguiente mensaje de error si intentas guardar el trigger tras marcar Habilitado y no seleccionar ninguna categoría o estado: 'No puedes guardar esta configuración, consulta la documentación para más información.'
- Cuando un registro de ausencia cambia de estado, el webhook se activará para el estado en el que está siendo enviada la ausencia, por ejemplo: si Aprobación pendiente está marcada y se envía un borrador de ausencia para su aprobación, se activará el webhook.
- Si se elimina un plan de ausencia que se ha seleccionado en las configuraciones (con el estado Eliminado marcado), se enviará un webhook por cada ausencia eliminada dentro del plan.
- Si se seleccionas la categoría de Vacaciones, al publicar un día festivo obligatorio se activará el Webhook.
Configuración de Personal saliente y Nuevas contrataciones
Al habilitar los triggers de Personal saliente y Nuevos empleados, hay una opción de configuración adicional disponible para cuando se active el webhook.
Para habilitar Nuevas contrataciones o Personal saliente debes:
- Marcar la casilla Habilitado.
- Selecciona Desencadenante en tiempo real o Desencadenante al día siguiente.
- Haz clic sobre Guardar y cerrar.
*Al seleccionar 'Desencadenante en tiempo real' el trigger se enviará automáticamente cuando se active, cambie o elimine un registro. Al seleccionar 'Desencadenante al día siguiente' todas las activaciones para bajas y nuevas contrataciones que sucedan en un día se enviarán esa misma noche.
Nota:
- Si sólo marcas Habilitado o marcas las tres casillas, obtendrás el siguiente mensaje de error: 'No puede guardar esta configuración, consulte la documentación para más información.'