El webhook de firmar.online informa de los eventos que propician cambios en el estado de los documentos, por lo que te permitirá realizar un seguimiento automatizado de cada uno de ellos. Cada vez que el documento enviado para su firma electrónica (DocumentSet) cambie de estado, firmar.online te informará de qué acción ha ocurrido para provocar este cambio de estado.

Aplica exclusivamente a los documentos procesados mediante las funciones de “enviar a firmar” y “firma presencial”. Es decir, cuando se quiere solicitar la firma electrónica de un documento a otra persona, ya sea en un proceso presencial o remoto (recuerda que la firma digital en servidor y la validación de la firma digital de documentos se realizan de forma síncrona. Por tanto, los documentos se devuelven automáticamente firmados. No tienen gestión de estados)

Puedes definir tu URL en el área de ajustes de la aplicación web.

Notificaciones “enviar a firmar” – firma digital remota

Las notificaciones se realizan en formato JSON de la siguiente manera

{
"eventType": 101,
"timestamp": "2021-09-22T10:14:30.7106693Z",
"data": {"documentSetToken": "8283524AF3C44AD3A43C295735050446"}
}

La información enviada sería la siguiente:

eventTypeCódigo tipo eventointeger
timestampFecha eventoISO 8601
data.recipientActionIdidentificador interno persona documentointenger
data.documentSetIdIdentificador interno sobreinteger
data.documentSetTokenIdentificador sobretexto
data.motivoRechazoMotivo rechazo sobretexto
data.referenceReferencia externa sobretexto

Las posibles acciones de las que informa el webhook, para firma remota, son las siguientes:

Evento

Descripción evento

Nuevo estado

Descripción estado

101

102

103

104

105

106

107

Sobre creado

Sobre completado

Caducado

Cancelado

Eliminado

Rechazado

Recordatorio enviado

200

300

700

400

600

500

200

En proceso

Completado

Caducado

Cancelado

Eliminado

Rechazado

En progreso

Notificaciones “firma presencial” – firma digital sobre dispositivos de la organización

En el caso de la firma digital sobre dispositivos de la organiación, el webhook incorpora también acciones que no significan un cambio de estado, además de información del dispositivo al que se ha enviado el documento.
Las notificaciones se realizan en formato JSON de la siguiente manera

{
  "eventType": 620,
  "timestamp": "2021-09-30T11:43:00.9782512Z",
  "data": {
    "dispositivoId": "92bdef6e-cb09-4ac3-a42e-c25b525b5df7",
    "procesoId": "6287B1CDB475474CBCC7ACFB26A0B28D"
  }
}

La información enviada sería la siguiente:

eventTypeCódigo tipo eventointeger
timestampFecha eventoISO 8601
data.dispositivoIdIdentificador dispositivotexto
data.procesoIdIdentificador procesotexto
data.eventDetaildescripción nuevo estadotexto

Las posibles acciones de las que informa el webhook, para firma presencial, son las siguientes:

evento

600
610
620
640
650
700
710
720
630
730
740
750
760

descripción del evento

Nuevo documento enviado a dispositivo
Nuevo documento por OTP para dispositivo
Obtener información documento
Obtener estado documento
Obtener listado histórico trazabilidad
Dispositivo solicita documento más antiguo para firmar
Dispositivo solicita todos los documentos a firmar
Dispositivo envía documento firmado
Borrado documento previo envío
Dispositivo rechaza documento
Solicitud dispositivo eliminar documento
Dispositivo notifica error en documento
Solicitud dispositivo cambio estado documento

Pasos para probar el webhook de firma digital

Puedes probar la funcionalidad y ver cómo llegan las respuestas en este portal web, https://webhook.site/ Para ello, tendrías que seguir los siguientes pasos:

1.- Acceder a https://webhook.site/

Verás que automáticamente te asigna una URL, con este formato https://webhook.site/#!/d0d83771-363c-4e09-aae0-6c8a447181cd

2.- Copia esta URL en la sección de Ajustes de la aplicación web. Funciona tanto en el entorno de producción (https://app.firmar.online) como en el de integraciones (https://app.firmar.info). Puedes configurar la misma URL de mismo webhook a los dos entornos.

3.- El la web https://webhook.site/ verás cómo se van reflejando las diferentes acciones realizadas en firmar.online