Mit Webhooks können Sie auf Ereignisse reagieren, die von bestimmten Prozessen in einem Repository ausgelöst werden. Zusätzlich können Sie mit den HTTP-Antworten Ihrer Webhooks die Ausführung der Prozesse beeinflussen.

Um einen Webhook zu konfigurieren, müssen Sie eine URI bereitstellen. Diese URI wird beim Auftreten des Ereignisses aufgerufen. Sie können für ein Ereignis mehrere Webhooks konfigurieren. Diese Webhooks werden beim Eintreten des Ereignisses nacheinander aufgerufen.

Tragen Sie die Konfigurationen der Webhooks im Menüeintrag Webhooks für die gewünschten Ereignisse ein.

Für eine Reihe von Ereignissen, die bei der Arbeit mit Dokumenten in einem Repository auftreten können, lassen sich Webhooks aufrufen.

Wenn das Ereignis eintritt, wird an jede eingetragene URL eine HTTP-POST-Anforderung gesendet. Abhängig vom gewählten Ereignis werden im Body der HTTP-POST-Anforderung verschiedene Informationen an den Webhook übergeben z. B. zu einem gespeicherten Dokument. Diese Informationen kann der Webhook verwenden, um auf Basis der Informationen weitere Aktionen zu starten.

Für jedes Ereignis werden im Folgenden die Informationsobjekte beschrieben.

Suchen

Diese Ereignisse werden ausgelöst, wenn Anwendende eine Suche im Repository ausführen.

Das Ereignis wird vor einer Suche aufgerufen. Die übergebenen Suchkriterien sind zu dem Zeitpunkt noch nicht auf Plausibilität geprüft worden.

Das Ereignis wird am Ende der Suche aufgerufen, direkt bevor die Ergebnisse an den Benutzer geliefert werden.

Dokumente und Akten erstellen

Diese Ereignisse werden ausgelöst, wenn ein neues Dokument oder eine Akte im Repository gespeichert wird.

Das Ereignis wird aufgerufen, wenn einem neu importierten Dokument Eigenschaften zugewiesen wurden.

Das Ereignis wird aufgerufen, bevor Anwendende ein Dokument oder eine Akte erstellen. Du kannst die Werte der erweiterten Eigenschaften im Webhook ändern.

Das Ereignis wird aufgerufen, nachdem Anwendende ein Dokument oder eine Akte erstellt haben. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Neue Version erstellen

Diese Ereignisse werden ausgelöst, wenn eine neue Version eines Dokuments im Repository gespeichert wird.

Das Ereignis wird aufgerufen, bevor Anwendende eine neue Version eines Dokuments erstellen. Bei diesem Ereignis wurde geprüft, ob das Dokument bereits im Repository existiert. Die erweiterten Eigenschaften können sich du zu diesem Zeitpunkt noch ändern.

Das Ereignis wird aufgerufen, nachdem Anwendende eine neue Version eines Dokuments erstellt haben. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Eigenschaften aktualisieren

Diese Ereignisse werden ausgelöst, wenn die Eigenschaften eines Dokuments oder einer Akte geändert werden.

Das Ereignis wird aufgerufen, wenn die Dokumenteigenschaften überprüft werden.

Das Ereignis wird aufgerufen, bevor die Eigenschaften eines Dokuments aktualisiert werden. Du kannst die Werte der erweiterten Eigenschaften im Webhook ändern.

Das Ereignis wird aufgerufen, nachdem die Eigenschaften eines Dokuments aktualisiert wurden. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Dokumente und Akten löschen

Diese Ereignisse werden ausgelöst, wenn ein Dokument oder eine Akte aus dem Repository entfernt wird.

Das Ereignis wird aufgerufen, bevor ein Benutzer ein Dokument oder eine Akte löscht. Zu diesem Zeitpunkt wurde bereits geprüft, ob der Benutzer das Dokument löschen darf.

Das Ereignis wird aufgerufen, nachdem ein Benutzer ein Dokument oder eine Akte gelöscht hat. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Elemente verknüpfen

Ereignisse des Typs Elemente verknüpfen werden ausgelöst, wenn zwei Elemente miteinander verknüpft werden. Das Ereignis wird bei folgenden Verknüpfungen ausgelöst:

Das Ereignis wird aufgerufen, bevor zwei Elemente verknüpft werden.

Das Ereignis wird aufgerufen, nachdem zwei Elemente verknüpft wurden. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Status ändern

Diese Ereignisse werden ausgelöst, wenn der Status eines Dokuments geändert wird.

Das Ereignis wird aufgerufen, bevor der Dokumentstatus geändert wird.

Das Ereignis wird aufgerufen, nachdem der Dokumentstatus geändert wurde. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Generiertes Dokument erstellen

Diese Ereignisse werden ausgelöst, wenn zu einem Dokument eine neue, abhängige Datei gespeichert wird. In einem Repository wird dieses Ereignis durch die automatische Generierung eines langzeitstabilen PDF-Abbilds des Dokuments ausgelöst.

Das Ereignis wird aufgerufen, bevor eine neue abhängige Datei gespeichert wird.

Das Ereignis wird aufgerufen, nachdem eine neue abhängige Datei gespeichert wurde. Der Prozess ist bei diesem Ereignis bereits abgeschlossen.

Sie können den jeweiligen Ereignissen zugeordnete Webhook-Einträge bearbeiten , hinzufügen oder löschen.

Webhooks werden beim Eintreten des Ereignisses nacheinander aufgerufen. Sie können die Reihenfolge der Abarbeitung verändern mit Reihenfolge bearbeiten. Mit Position verschieben Sie einen markierten Webhook-Eintrag innerhalb der Liste.

Mit Aktualisieren können Sie die Webhook-Konfiguration vom Server neu laden lassen.

Mit Export und Import können Sie die Webhook-Konfigurationen exportieren und importieren. Die Konfigurationsdaten werden als JSON-Datei übertragen .

Tragen Sie als Konfigurationskennung einen Namen für den Webhook ein. Die ID des Webhooks wird automatisch generiert und kann nicht geändert werden.

Die URI bestimmt die Webadresse, die beim Eintreten eines Ereignisses aufgerufen wird. Das System unterstützt absolute HTTP-Adressen und relative Pfadangaben für lokale Webadressen. Während der Eingabe erfolgt eine einfache Plausibilitätsprüfung der URI, aber keine Prüfung der Verbindung.

Wählen Sie Webhook aktivieren aus, um den Webhook im DMS-System zu aktivieren.

Auswerten der Antwort des Webhooks

Sie können festlegen, ob und wie die HTTP-Antwort Ihres Webhooks vom DMS-System ausgewertet werden soll.

Verwenden Sie Nicht auf Antwort warten für Webhooks, die nicht auf den laufenden Prozess einwirken müssen. Der Aufruf des Webhooks geschieht asynchron. Das DMS-System wartet nicht auf eine HTTP-Antwort. Die Laufzeit des Prozesses wird nicht beeinträchtigt.

Verwenden Sie Statuscode berücksichtigen für Webhooks, die den Prozess abbrechen können. Der Aufruf des Webhooks geschieht synchron und die HTTP-Antwort wird abgewartet. Das DMS-System wertet nur den Statuscode der HTTP-Antwort aus. Mit dem Statuscode kann der laufende Prozess abgebrochen werden. Der Webhook muss dafür einen Statuscode im Bereich von 400 bis 499 zurückgeben.

Verwenden Sie Statuscode berücksichtigen und Antwort auswerten für Webhooks, die den Prozess abbrechen oder verändern. Der Aufruf des Webhooks geschieht synchron und die HTTP-Antwort wird abgewartet. Das DMS-System wertet den Statuscode und den Inhalt der HTTP-Antwort aus.

Einschränken auf eine bestimmte Kategorie

Mit Nur für diese Kategorie ausführen schränken Sie die Ausführung der Webhooks auf eine Kategorie ein. Wenn Sie keine Kategorie auswählen, dann wird der Webhook für jede Kategorie aufgerufen.

Festlegen eines Authentifizierungsschlüssels

Mit der Option API-Key legen Sie einen Authentifizierungsschlüssel fest. Dieser Authentifizierungsschlüssel wird beim HTTP-Aufruf des Webhooks mitgesendet. Dadurch kann der Webhook überprüfen, ob der HTTP-Aufruf tatsächlich von dem DMS-System stammt. Authentifizierungsschlüssel werden nur gesendet, wenn Sie als URI eine relative URI angegeben haben.

Wählen Sie das Sternchen (*) neben dem Eingabefeld aus, um den API-Key als Klartext anzuzeigen.

Beeinflussen der Performance

Verwenden Sie Timeout in Millisekunden, um festlegen, wie lange das DMS-System auf die HTTP-Antwort des Webhooks wartet. Nach Ablauf des Timeouts wird die HTTP-Anfrage abgebrochen.

Aktivieren Sie die Timeout-Wiederholung mit Webhook bis zu drei Mal aufrufen, falls ein Timeout oder eine fehlerhafte Antwort auftritt. Wenn ein Timeout auftritt, wird die HTTP-Anfrage erneut ausgeführt. Die HTTP-Anfrage wird maximal vier Mal gesendet, bevor sie endgültig verworfen wird.

Informationsfelder

Im Textfeld ID wird die interne Identifikation des Webhooks angezeigt. Das Textfeld Entry point zeigt die interne Zuordnung des Webhooks zu einem Ereignis an.