Webhooks

Notifique a otras aplicaciones empresariales cuando se almacenen nuevos documentos en un archivador o se modifiquen entradas de índice asociadas. Los datos de índice de los documentos especificados pueden incluirse en el contenido del mensaje. Otras aplicaciones de la empresa pueden sincronizar sus datos o iniciar acciones y flujos de trabajo concretos.

DocuWare se comunica con aplicaciones de terceros mediante una URL que engancha las dos aplicaciones; este proceso recibe el nombre de "webhook", donde "hook" significa "gancho". DocuWare envía la notificación como solicitud POST a la URL que supervisa la aplicación externa y que por tanto, recibe el mensaje.

Por ejemplo, cuando una presentación nueva se almacena en un archivador DocuWare, se puede enviar una notificación al canal de Microsoft Teams compartido para este proyecto, y así informar a todos los empleados pertinentes de inmediato.

Requisitos

Los webhooks solo están disponibles para los clientes de DocuWare Cloud y DocuWare in situ. Por el contrario, en Configuración de DocuWare solo pueden ver el módulo aquellos usuarios con la función Organization Administrator.

Configuración

Para crear un webhook, primero cree un servicio web de tipo REST en Configuración de DocuWare > Integraciones. Una vez en el servicio web, introduzca la URL a través de la cual DocuWare y la aplicación receptora se comunican entre sí.

Luego, diríjase al módulo Integraciones > Webhooks y configure la notificación.

Eventos

En la ficha Eventos, especifique el servicio web con la URL y el archivador que contiene los documentos por los que es necesario enviar una notificación. Hay dos activadores que desencadenan una notificación del archivador: archivar un nuevo documento o modificar los datos de índice de un documento ya archivado.

A continuación, utilice el filtro para seleccionar los documentos sobre los que se enviará una notificación.

El contenido de los campos de la tabla no se puede transferir en la solicitud POST.

Cuerpo de la solicitud HTTP

El cuerpo del mensaje alberga el contenido de la notificación. De forma predeterminada, los campos de índice del archivador ya estarán insertados con los datos de índice de los documentos seleccionados en Eventos. El formato de los datos es JSON.

Puede editar y modificar el contenido, por ejemplo, para transmitir los datos de índice a la aplicación receptora en un formato concreto. Lo más importante es que se comunique un formato JSON válido.

Use el valor "marcador de posición" para enviar los datos de índice pertinentes. Este marcador de posición se puede insertar en el editor de JSON en cada campo de índice con tan solo hacer clic.

Al hacer clic en el botón Validar y dar formato se mostrarán los errores en el cuerpo del texto. Las líneas incorrectas se resaltan con una explicación. La validación se realiza automáticamente al guardar. Si se produce un error, el webhook no se guarda.

Permisos

Ahora, los derechos para los webhooks se pueden asignar para cada configuración de la forma habitual, ya sea individualmente por usuario o mediante funciones. Un usuario solo ve los webhooks para los que tiene permisos, y puede editarlos y eliminarlos.