Webhooks

INDICE

I. Introducción

II. ¿Cómo configurar un nuevo webhook?

1. ¿Cómo hacer pruebas?

III. ¿Cómo puedo editar o borrar un webhook?

IV. ¿Cómo puedo ver el detalle de un webhook?

V. ¿Cómo puedo consultar el historial de logs?

I. Introducción:

El flujo de Webhooks es aquel que permite configurar la comunicación a servicios web externos para informar sobre entidades que sean susceptibles de enviar una notificación remota; en otras palabras, facilita al cliente notificaciones en tiempo real de lo sucedido en algunas de nuestras entidades.

Las notificaciones podrán activarse dependiendo del ciclo de vida o estatus que se requiera de cada entidad. Dichas notificaciones serán enviadas como un mensaje Json.

II. ¿Cómo configurar un nuevo webhook?

En “Configuración General” se encuentra el apartado de “Webhooks” donde se podrá crear un nuevo webhook al dar clic en el botón de “Nuevo Webhook”:

Se abrirá el siguiente modal que tiene un mensaje donde se recomienda tener apoyo del equipo técnico para hacer esta configuración, ya que lo que hace el servicio es poder informar por medio del envío de un Json cuando una acción se ejecuta:

La información que se solicita es:

• Nombre: nombre con el que se identificará la configuración
• Código: código sin espacios como identificador en la aplicación
• URL: URL a la que se comunicarán las notificaciones remotas. Por el momento sólo se pueden usar URLs con protocolo HTTP y HTTPS.
• Token: valor (token) que permita identificar que somos realmente nosotros quienes estamos enviando notificaciones
• Presente en: valor donde se debe enviar el token o identificador de la solicitud (Header, Query string o Payload)
• Llave identificador token: valor opcional que puede mostrar una llave con la que se identifica el token. En caso de que no se seleccione la llave a utilizar para una petición con token en el Header será “Authorization”, en los otros casos la llave del token será la palabra “token”.
• Entidad: asociación entre la configuración y las distintas entidades susceptibles para realizar notificaciones remotas. Para cada entidad se deberá definir según sus propiedades, si notifica el ciclo de vida, para qué eventos se deben entregar las notificaciones remotas, y para los cambios de estado lo mismo. Cada entidad, ciclo de vida o estatus, tiene la posibilidad de ser seleccionado con un checkbox para que pueda notificarse al momento en el que uno de éstos momentos sea ejecutado.
  • Estado de periodo: entidad que informa el estatus de un periodo específico. Consta de 3 fases en su ciclo de vida que pueden ser informadas.
    • Abierto - cuando se crea un nuevo periodo
    • Cerrado - cuando un periodo se ha cerrado y ya no se pueden hacer más cambios a su configuración
    • Consolidado - cuando el periodo ha sido  consolidado
  • Contratos: entidad que informa el ciclo de vida de un contrato específico
    • Crear - cuando se crea un nuevo contrato
    • Actualizar - cuando se actualiza información de un contrato existente
    • Eliminar - cuando se elimina un contrato en la base de datos.
  • Faltas: entidad que informa el ciclo de vida de una falta específica
    • Crear - cuando se crea una nueva falta
    • Actualizar - cuando se actualiza información de una falta existente
    • Eliminar - cuando se elimina un contrato en la base de datos.
  • Vacaciones: entidad que informa el ciclo de vida de unas vacaciones específicas
    • Crear - cuando se crea un nuevo periodo de vacaciones
    • Actualizar - cuando se actualiza información de un periodo de vacaciones existentes
    • Eliminar - cuando se elimina un contrato en la base de datos.

Al final se encuentra la opción de “Guardar” la configuración, “Cancelar”  o “Probar” los cambios hechos o los cambios hechos.

1. ¿Cómo hacer pruebas?

Una vez que se tiene la configuración hecha, al momento de darle clic al botón de “Probar” se abrirá un nuevo modal que te mostrará un espacio para poner un ejemplo del mensaje en formato Json que se enviaría.

Una vez habiendo confirmado que el mensaje a enviar es correcto se debe dar clic al botón de “Probar” y arrojará un mensaje de éxito o error según sea el caso. En caso de que haya habido un error, mostrará el detalle de éste para que se pueda analizar y revisar la configuración del webhook o algún problema en el receptor.

III ¿Cómo puedo editar o borrar un webhook?

Si se quiere editar una configuración ya creada se debe ir al menú individual (3 puntos) y seleccionar la opción de “Editar” que abrirá nuevamente el modal de configuración y permitirá hacerle cambios: 

Si se quiere editar una configuración ya creada se debe ir al menú individual (3 puntos) y seleccionar la opción de “Eliminar”: 

Saldrá un modal de confirmación, en caso de estar seguro de eliminar dicho webhook se debe poner “Aceptar”.

IV. ¿Cómo puedo ver el detalle de un webhook?

Para ver el detalle de un webhook se debe dar clic en el botón “Ver detalle”:

Se abrirá el modal donde se mostrará la información del webhook consultado: 

V. ¿Cómo puedo consultar el historial de logs?

Para consultar el Historial de logs de cada webhook, debes dar clic en el menú individual (3 puntos) y en la opción “Historial de logs”:

Se abrirá una pantalla donde podrás ver una leyenda que especifica que nuestra política de retención de logs de respuesta es de 7 días.

En esta sección se cuenta con un filtro de fechas desde-hasta y con la posibilidad de ver en una tabla la siguiente información de cada log:

• ID = identificador del log
• Fecha = fecha de envío del log
• Payload = Json con detalle de envío
• Respuesta = Json con detalle de respuesta
• Código de respuesta = código que regresa la respuesta del envío y que informa si fue recibida o no con éxito.