Integration

Webhooks

Die Einstellungen für Webhooks erreichen Sie über die Rubrik Integrationen. Innerhalb des Menüpunktes Webhooks lassen sich diese erstellen und verwalten.

Geben Sie zunächst einen Namen für den Webhook ein. Dieser wird beim Auslösen stets mit übertragen. Die Angabe eines (Authentifizierungs-)Token ist optional - die Erfordernis richtet sich nach den Sicherheitsbestimmungen des Zielservers. Als URL ist die Zieladresse einzutragen, an welche die Meldung über ein ausgelöstes Element (Ereignis) gesendet werden soll.

Durch die Zuordnung von Elementen in der Kategorie Auslöser kann bestimmt werden, für welche Objekte Änderungsmeldungen übermittelt werden sollten.

Auslöser werden erst bei erfolgter Ab-/Anmeldung vom System aktualisiert.

Das System überträgt die nachstehenden Parameter an die Zieladresse.
Für die Eigenschaft action wird zwischen

CREATE
UPDATE
DELETE

unterschieden. Die Eigenschaften endpoint und id geben Aufschluss über den betroffenen Datensatz. Mittels dieser Angaben, lassen sich bei Bedarf weitere Informationen über die API abrufen.

Ausgabebeispiel


{

    "5": {

     "webhook": "Beispiel",

     "action": "CREATE",

     "endpoint": "accounts",

     "id": "1",

     "client": "00000"

    }

}