El propósito del presente documento es explicar las características del Webhook a configurar en Signio, esta es una solicitud que interviene cuando ocurre un cambio de estado en un sobre de Signio. Los Webhook se utilizan para enviar notificaciones en tiempo real, por lo que el llamado se realiza cuando se produce el evento.
Para que este proceso sea efectivo es necesario que el cliente exponga un servicio REST o SOAP que Signio pueda invocar para transmitir la información del sobre requerida por el sistema receptor.
Ejemplo: Recibir los documentos de las transacciones firmadas. Para tal efecto se debe configurar en Signio para que en el evento de firmado Signio envíe el id de la transacción y los documentos de dicha transacción.
CONFIGURACIÓN DE WEBHOOK EN SIGNIO
Signio permite registrar webhooks para los sobres creados en la plataforma, estos se ejecutarán dependiendo del cambio de estado de los sobres según la configuración especificada. La finalidad de estos webhooks es realizar llamadas a endpoint(callbacks) indicando que un evento ha ocurrido en signio con los sobres creados. En dicho callback puede viajar informacion de interes como el identificador del sobre, los paths de los documentos generados, los campos utilizados para llenar dichos documentos entre otros.
1. Ingresar al módulo de Webhooks ubicado en el menú de configuración
2. Una vez se ingresa al módulo Webhooks, se debe dar clic en “Nuevo”
3. Se le mostrará una ventana donde podrá especificar la configuración de su webhook
En este punto se debe definir cuáles serán las variables que se deben enviar en el momento en que suceda uno de los eventos definidos. A continuación se describen las variables que Signio tiene disponible para enviar:
Para realizar la configuración se debe arrastrar la variable a enviar al lado izquierdo de la pantalla, en la sección “Variables a enviar”.
Aquí un ejemplo de cómo quedaría configurado en webhook
EJEMPLO DE RESPUESTA DEL JSON:
