Webhooks

Prev Next

Alertez les autres applications commerciales lorsque des documents viennent d'être stockés dans une armoire ou que des entrées d'index associées sont modifiées. Les données d'index des documents spécifiés peuvent être incluses dans le contenu du message. Les autres applications de l'entreprise peuvent réagir, synchroniser leur stock de données ou déclencher des actions et des workflows spécifiques.

DocuWare communique avec des applications tierces par le biais d'une URL qui « accroche » les deux applications (webhook). DocuWare envoie la notification sous forme de requête POST à l'URL surveillant l'application tierce et reçoit donc le message.

Par exemple, lorsqu'une nouvelle présentation est stockée dans l'armoire DocuWare, une notification est immédiatement envoyée sur le canal partagé Microsoft Teams pour ce projet, afin que tous les collaborateurs concernés soient informés sans délais.

Exigences :

Les Webhooks sont uniquement disponibles pour les clients de DocuWare Cloud et DocuWare en local. Dans la configuration DocuWare, cependant, le module n'est visible que pour les utilisateurs auxquels a été attribué le rôle d'Administrateur de l'organisation.

Configuration

Pour créer un webhook, créez d'abord un service Web de type REST dans Configuration DocuWare > Intégrations. Dans le service web, saisissez ici l'URL par laquelle DocuWare et l'application réceptrice communiquent entre eux.

Rendez-vous ensuite dans le module Intégrations > Webhooks et configurez la notification.

Événements

Dans l'onglet Événements, indiquez le service Web avec l'URL et l'armoire contenant les documents pour lesquels une notification doit être envoyée. Il existe deux déclencheurs pour une notification d'armoire : le stockage d'un nouveau document ou la modification des données d'index d'un document déjà stocké.

Ensuite, utilisez le filtre pour sélectionner les documents pour lesquels une notification sera envoyée.

Le contenu des champs de table ne peut pas être transféré dans la requête POST.

Corps de la demande HTTP

Le corps du texte ne contient pas le contenu de la notification. Par défaut, les champ d'index de l'armoire sont déjà insérés avec les données d'index des documents sélectionnés dans Événements. Les données sont au format JSON.

Vous pouvez éditer et modifier le contenu, par exemple pour transmettre les données d'index à l'application réceptrice, dans un format spécifique. Ce qui compte, c'est qu'un format JSON valide soit communiqué.

Utilisez la valeur « espace réservé » pour distribuer les données d'index pertinentes. Ce caractère générique peut être inséré dans l'éditeur JSON pour chaque champ d'index, d'un simple clic.

En cliquant sur le bouton Valider et formater, les erreurs s'affichent dans le corps du texte. Les lignes incorrectes sont mises en surbrillance et accompagnées d'une explication. La validation est effectuée automatiquement lors de l'enregistrement. En cas d'erreur, le webhook n'est pas enregistré.

Autorisations

Les droits d'accès aux webhooks peuvent maintenant être assignés pour chaque configuration de la manière habituelle, soit par utilisateur individuel, soit via des rôles. Un utilisateur ne voit alors que les webhooks pour lesquels il dispose d'autorisations et peut les modifier et les supprimer.