Webhook

Einstellungen für ausgehende Webhooks: Endpunkte für Sendungs- und Tour-Ereignisse konfigurieren, testen sowie eine Warn-E-Mail bei fehlgeschlagener Zustellung einrichten.

Auf dem Reiter Webhooks der Einstellungen richten Sie ausgehende Webhooks ein. Mit Webhooks meldet X4fleet bestimmte Ereignisse – etwa Statusänderungen von Sendungen oder Touren – automatisch an ein externes System (z. B. ein ERP- oder Kundensystem). Sobald ein konfiguriertes Ereignis eintritt, sendet X4fleet die zugehörigen Daten an die hinterlegte Adresse (URL). Dieser Reiter richtet sich an Administratoren, die X4fleet mit Drittsystemen verbinden.

Hinweis: Alle Anpassungen auf diesem Reiter werden zusammen mit den übrigen Einstellungen über die Schaltfläche zum Speichern der Einstellungen übernommen.


1. Navigation

Den Reiter Webhooks finden Sie innerhalb der Einstellungen in der Reiterleiste der Einstellungsseite.

Einzelne Optionen (z. B. die gruppenübergreifende Anwendung) sind nur sichtbar, wenn Sie sich in der Hauptgruppe befinden.


2. Warn-E-Mail bei fehlgeschlagener Zustellung

Damit Sie nicht unbemerkt Daten verlieren, kann X4fleet bei einem fehlgeschlagenen Webhook-Versand automatisch eine Warn-E-Mail versenden.

Warn-E-Mail aktivieren

  1. Aktivieren Sie die Checkbox «Warn-E-Mail aktiv».
  2. Tragen Sie im Feld «Warn-E-Mail» die Empfängeradresse ein, an die die Benachrichtigung gesendet werden soll.
  3. Speichern Sie die Einstellungen.

Schlägt anschliessend die Zustellung eines Webhooks fehl, erhält die hinterlegte Adresse eine entsprechende Warnmeldung.

Für Untergruppen übernehmen

Befinden Sie sich in der Hauptgruppe, steht zusätzlich die Option «Für Untergruppen übernehmen» zur Verfügung. Ist sie aktiviert, gilt die Warn-E-Mail-Konfiguration auch für die untergeordneten Gruppen.

Vorlage der Warn-E-Mail bearbeiten

Den Inhalt der Warn-E-Mail können Sie mehrsprachig anpassen. Über den Texteditor bearbeiten Sie die Vorlage in den verfügbaren Sprachen. Mit den Einfüge-Schaltflächen des Editors können Sie Platzhalter (Variablen) in den Text einsetzen, die beim Versand automatisch durch die jeweiligen Werte ersetzt werden.

Hinweis: Pflegen Sie die Vorlage in allen benötigten Sprachen, damit die Empfänger die Warnmeldung in der korrekten Sprache erhalten.


3. Webhook-Endpunkte für Sendungen und Touren

Auf dem Reiter stehen zwei getrennte Listen zur Verfügung:

  • Sendungs-Webhooks – Endpunkte, die bei Ereignissen zu Sendungen ausgelöst werden.
  • Tour-Webhooks – Endpunkte, die bei Ereignissen zu Touren ausgelöst werden.

In beiden Listen können Sie beliebig viele Endpunkte hinzufügen, konfigurieren, testen und wieder entfernen.

Endpunkt hinzufügen

  1. Klicken Sie in der gewünschten Liste (Sendungen oder Touren) auf die Schaltfläche «+».
  2. Eine neue, leere Zeile wird der Liste hinzugefügt.
  3. Konfigurieren Sie die Zeile wie in Abschnitt 4 beschrieben.
  4. Speichern Sie die Einstellungen.

Endpunkt entfernen

Über das Entfernen-Symbol der jeweiligen Zeile löschen Sie einen Endpunkt wieder aus der Liste. Speichern Sie anschliessend die Einstellungen, damit die Änderung wirksam wird.


4. Konfiguration eines Endpunkts

Jeder Webhook-Endpunkt wird über eine eigene Zeile mit den folgenden Feldern konfiguriert:

FeldBeschreibung
AktivAktiviert oder deaktiviert den Endpunkt. Nur aktive Endpunkte werden ausgelöst.
Für Untergruppen aktivÜbernimmt den Endpunkt auch für untergeordnete Gruppen (nur in der Hauptgruppe sichtbar).
Pull-ModusSchaltet zwischen Push- und Pull-Betrieb um. Im Pull-Modus wird das URL-Feld ausgeblendet, da kein aktiver Versand an eine Zieladresse erfolgt.
URLDie Zieladresse, an die X4fleet die Daten sendet (nur bei deaktiviertem Pull-Modus).
Sendungen einschliessenBezieht die Sendungsdaten in die übermittelte Nutzlast ein.
Transportpunkte einschliessenBezieht die Transportpunkte (Abhol-/Zustellpunkte) ein.
Nicht relevante Split-Sendungen ausschliessenSchliesst nicht relevante Teilsendungen aus Splits aus.
AuslöserMehrfachauswahl der Status, bei denen der Webhook ausgelöst wird (Sendungsstatus bzw. Tourstatus).
Inhaltstyp der AnfrageFormat der übermittelten Daten (Content-Type der Anfrage).
Nutzlast als Zeichenkette codierenÜbermittelt die Nutzlast als kodierte Zeichenkette.
Datums-/ZeitformatFestlegung des Formats für Datums- und Zeitangaben in der Nutzlast.
BenutzernameAnmeldename für die Authentifizierung am Zielsystem.
PasswortPasswort für die Authentifizierung am Zielsystem.
ZertifikatZertifikat für eine gesicherte Verbindung zum Zielsystem.

Über das Feld Auslöser legen Sie fest, bei welchen Statusänderungen der Endpunkt aufgerufen wird. Für Sendungs-Webhooks stehen die Sendungsstatus zur Auswahl, für Tour-Webhooks die Tourstatus.

Hinweis: Das URL-Feld wird nur angezeigt, wenn der Pull-Modus deaktiviert ist. Aktivieren Sie den Pull-Modus, wenn das Zielsystem die Daten selbst abruft, statt sie von X4fleet zugesendet zu bekommen.


5. Endpunkt testen

Bevor Sie einen Endpunkt produktiv einsetzen, können Sie ihn direkt aus der Zeile heraus testen.

  1. Konfigurieren Sie die Zeile mit den gewünschten Werten (insbesondere URL und Anmeldedaten).
  2. Klicken Sie auf die Schaltfläche «Webhook testen» der jeweiligen Zeile.
  3. X4fleet sendet eine Testanfrage an die konfigurierte Adresse und zeigt das Ergebnis an.

So überprüfen Sie, ob die Zieladresse erreichbar ist und die Authentifizierung korrekt funktioniert, ohne auf ein echtes Ereignis warten zu müssen.


6. Speichern

Sämtliche Konfigurationen dieses Reiters – die Warn-E-Mail-Einstellungen ebenso wie die Sendungs- und Tour-Endpunkte – werden gemeinsam mit den übrigen Einstellungen gespeichert. Änderungen werden erst nach dem Speichern wirksam.

Hinweis: Hinzugefügte oder entfernte Endpunkte sowie geänderte Feldwerte gelten erst, nachdem die Einstellungen gespeichert wurden.