Anmerkung
Das Webhooks-Feature befindet sich momentan in der Beta-Phase und ist ab Version 23.0.13 hinter einer Feature-Flag verfügbar.
Möchtest du es ausprobieren? Dann kontaktiere uns unter: api[at]xentral.com.
Ein Webhook erlaubt es dir, Informationen über Ereignisse in Xentral, sogenannte Events, in einem externen System zu empfangen. Du kannst zum Beispiel eine Benachrichtigung in deiner Anwendung erhalten, sobald ein neuer Auftrag erstellt wird. Diese Information wird über eine HTTP POST-Anfrage an dein externes System gesendet.
Tipp
Zusätzliche technische Informationen zu Webhooks und möglichen Events findest du in der Entwicklerdokumentation.
Anmerkung
Das Erstellen von Webhooks erfordert Administrator-Rechte.
Gehe wie folgt vor, um einen Webhook zu erstellen:
-
Navigiere zu
Einstellungen > Integrationen > Webhooks. Eine Liste aller aktiv verwendeten Webhooks wird angezeigt. -
Klicke auf + Webhook erstellen. Sind keine Webhooks aktiv, findest du die Schaltfläche in der Mitte des Bildschirms. Ansonsten findest du sie auf der rechten Seite über deiner Liste.
-
Gib einen eindeutigen Namen für deinen Webhook ein. Der Name darf aus maximal 100 Zeichen bestehen.
-
Gib den URL-Endpunkt ein, der Informationen vom Webhook erhalten soll. Es sind nur sichere https-URLs erlaubt.
-
Achte auf den Signaturschlüssel. Er wird in deine Zwischenablage kopiert, sobald du die Erstellung des Webhooks abgeschlossen hast. Dieses Feld wird automatisch mit einer zufälligen 20-stelligen Zeichenfolge gefüllt, welche als Signaturschlüssel dient. Wenn du möchtest, kannst du ihn mit einer eigenen Zeichenfolge von 20 bis 255 Zeichen überschreiben oder den Schlüssel selbst in die Zwischenablage kopieren, indem du auf
im Feld Signaturschlüssel klickst und die Zeichenfolge kopierst.Wichtig
Der Signaturschlüssel erlaubt es dem empfangenden System sicherzustellen, dass die Information auch wirklich von Xentral ausgeht. Zeige den Schlüssel nicht öffentlich und baue ihn nicht in deinen Quellcode ein.
-
Wähle ein Event aus. Du kannst bei Bedarf auch mehrere Events auswählen. Der Webhook sendet immer dann Informationen an den Endpunkt, sobald eines der Events eintritt.
-
Klicke auf Erstellen. Der Signaturschlüssel wird in die Zwischenablage kopiert und erscheint ein letztes Mal auf dem Bildschirm. Klicke auf
, um sicher zu stellen, dass der Schlüssel kopiert wurde. -
Schließe das Fenster.
Dein neuer Webhook wird in der Liste der aktiven Webhooks angezeigt. In der Übersicht kannst du die URL-Endpunkte und zugehörigen Events deiner Webhooks schnell erkennen
Alle Webhooks sind unter Einstellungen > Integrationen > Webhooks gelistet. Wenn du auf 
Bearbeiten klickst, hast du zwei Optionen:
-
Einstellungen bearbeiten - Du kannst den Namen, URL-Endpunkt und Signaturschlüssel ändern sowie Events zum Webhook hinzufügen oder entfernen. Falls du den Signaturschlüssel änderst, musst du ihn auch in deiner externen Anwendung anpassen.
-
Webhook löschen - Klicke auf Webhook löschen unterhalb der Liste von Events und bestätige die Löschung. Das externe System wird nun keine neuen Informationen mehr über Events in Xentral erhalten.