Webhooks

Hinweise zur Funktion

Bitte beachten Sie, dass die Webhooks beim Speichern einer Entität ausgelöst werden. Die Speicherfunktionen können den Webhook auch mehrfach auslösen (z. B. wenn eine verbundene Unter-Entität gespeichert wird). Die Webhooks können deshalb auch über Änderungen an Daten informieren, welche über die API nicht ermittelt werden können.

Welche Webhooks bietet WOWIPORT:

Wir bieten derzeit Webhooks für folgende Entitäten an:

  • Personen (Person)

  • Verträge (LicenseAgreement)

  • Wirtschaftseinheiten (EconomicUnit)

  • Nutzungseinheiten (UseUnit)

  • Darlehen (Loan)

  • Aufträge (Commission)

  • Nachrichten (Ticket)

  • Buchungen (Booking)

  • Mitgliedschaft (CooperativeMembership)

  • Dokumenterzeugung (Document) ->Dokumente, welche in WOWIPORT erstellt wurden

  • individuelle Dateien (File) -> Dateien, welche in WOWIPORT hochgeladen wurden

  • Medien im Bestand (Media)

  • Eingangsrechnung (InvoiceReceipt)

  • Eingangsrechnung Zahlauftrag (InvoiceReceiptPaymentOrder)

Die Trigger-Events sind:

  • created

  • deleted

  • updated

Der Payload folgt dem folgenden Beispielschema:

Payload des Webhook
    "body": {
        "entityType": "file",
        "entityName": "individuelle Dateien",
        "id": 9999,
        "action": "Test",
        "nodeId": 7,
        "systemId": "openwowi-demo.wowiport.de",
        "instanceName": "wowiport-demo",
        "applicationBaseUrl": "https://openwowi-demo.wowiport.de",
        "userId": 412,
        "openWowiUrl": "/openWowi/v1.2/DocumentRead/UseUnit/FileData?...",
        "additionalInfo": null
    }

Der Webhook wird als POST Request ausgeführt.

Einrichtung eines Webhooks

Um auf die Webhook-Konfiguration zugreifen zu können, wird das Benutzerrecht "Web Hook" benötigt. Zudem benötigen Sie das Recht "Web Hook Warteschlangeneintrag" um ausgeführte Webhooks nachvollziehen zu können.

Der Webhook wird für einen API-Key eingerichtet. Hierzu findet sich ein separater Tab in der API-Key-Konfiguration.

Um den Webhook einzurichten, benötigen Sie eine URL, welche den POST Request empfangen kann. Der Systemzweck wird üblicherweise "Echt" oder "Test" lauten. Der Webhook kann aktiviert oder deaktiviert werden.

Sie haben auch die Möglichkeit, den Webhook mit Authentifizierungsdaten abzusichern.

Mögliche Authentifizierungsmethoden sind:

  • Keine

  • Bearer (Header: "Bearer Token")

  • Basic (Header: "Username" und "Password")

  • Custom (Definition von "Header Name" und "Header Wert" ist individuell möglich.)

Warum Webhooks und nicht WebSockets?

Die derzeit angebotenen Entitäten erfahren nur selten Änderungen. Sollte unser Kommunikationsmodul einmal als vollumfängliche Chat-Applikation eingeführt werden oder eine Live-Kommunikation mit hochfrequentem Datenaustausch nötig sein, werden wir diese Technologie in Erwägung ziehen.

Last updated