Wissensdatenbank

HR Webhooks

Ein Webhook benachrichtigt automatisch ein externes System, sobald in SELLERLOGIC Commerce Services ein bestimmtes HR-Ereignis eintritt — zum Beispiel, dass ein neuer Mitarbeiter angelegt wurde oder eine Abwesenheit genehmigt wurde. Sie hinterlegen dazu die Internet-Adresse des externen Systems und wählen aus, bei welchen Ereignissen benachrichtigt werden soll. SCS sendet dann automatisch eine Nachricht dorthin, sobald das Ereignis eintritt. Diese Seite richtet sich vor allem an technisch versierte Personen bzw. die IT-Abteilung, die eine Anbindung an ein externes System einrichten.

Nachgebauter Ausschnitt der Ansicht: /hr/webhooks

Was kann ich hier tun?

  • Alle eingerichteten Webhooks durchsuchen
  • Einen neuen Webhook mit Zieladresse und Ereignistypen anlegen
  • Einen Webhook bearbeiten, aktivieren/deaktivieren oder löschen
  • Einen Testversand an einen Webhook auslösen
  • Das Zustellprotokoll eines Webhooks einsehen und fehlgeschlagene Zustellungen erneut versenden

Schritt für Schritt

Einen neuen Webhook anlegen

  1. Klicken Sie oben rechts auf „Webhook hinzufügen".
  2. Geben Sie einen Namen, die URL des externen Systems sowie optional Max. Wiederholungen und Timeout (ms) an.
  3. Wählen Sie unter „Ereignistypen" mindestens ein Ereignis aus, bei dem der Webhook ausgelöst werden soll.
  4. Klicken Sie auf „Erstellen".

Einen Webhook testen

  1. Öffnen Sie den Webhook per Klick auf den Eintrag in der Liste.
  2. Klicken Sie im Seitenfenster auf „Testversand". Es wird sofort ein Testereignis an die hinterlegte URL gesendet.

Eine fehlgeschlagene Zustellung erneut senden

  1. Öffnen Sie den Webhook und scrollen Sie zum Zustellprotokoll.
  2. Klicken Sie bei einem Eintrag mit Status „Fehlgeschlagen" oder „Wiederholung" auf „Erneut senden".
  3. Es erscheint eine Rückfrage, die die Zieladresse nennt, an die die signierte Zustellung geht. Lesen Sie die Adresse und bestätigen Sie erst dann.

Warum wird hier gefragt? Eine erneute Zustellung ist kein lokaler Wiederholungsversuch. Der Nutzdatensatz geht mit gültiger Signatur an das fremde System - dort ist er von der ursprünglichen Zustellung nicht zu unterscheiden und lässt sich von hier aus nicht zurückholen.

Felder erklärt

Feld Bedeutung Hinweise/Auswirkung
Name Bezeichnung des Webhooks Pflichtfeld, dient nur der eigenen Übersicht
URL Internet-Adresse des externen Systems, an die die Benachrichtigung gesendet wird Muss eine gültige, öffentlich erreichbare HTTPS-Adresse sein; interne/lokale Adressen werden aus Sicherheitsgründen abgelehnt
Signatur-Geheimnis Geheimer Wert zur Absicherung der Zustellung Wird automatisch erzeugt, standardmäßig verborgen, per Augen-Symbol einblendbar
Ereignistypen Auswahl der HR-Ereignisse, bei denen der Webhook ausgelöst wird Mindestens ein Ereignis erforderlich
Max. Wiederholungen Wie oft eine fehlgeschlagene Zustellung automatisch erneut versucht wird —
Timeout (ms) Wie lange auf eine Antwort des externen Systems gewartet wird, bevor der Versuch als fehlgeschlagen gilt In Millisekunden
Aktiv Ob der Webhook derzeit ausgelöst wird Ein deaktivierter Webhook sendet keine Benachrichtigungen
Zustellprotokoll Verlauf aller Zustellversuche dieses Webhooks Zeigt je Versuch Status, Ereignistyp, ggf. HTTP-Status und Fehlermeldung

Werte & Status

Zustell-Status

Wert Bedeutung Was passiert dann
Ausstehend Die Zustellung wurde noch nicht versucht Wartet auf den nächsten Sendeversuch
Erfolgreich Das externe System hat die Benachrichtigung angenommen Keine weitere Aktion nötig
Fehlgeschlagen Die Zustellung ist endgültig gescheitert (alle Wiederholungen ausgeschöpft) Kann manuell per „Erneut senden" wiederholt werden
Wiederholung Die Zustellung ist fehlgeschlagen, wird aber automatisch erneut versucht Wird nach kurzer Zeit automatisch erneut ausgeliefert

Häufige Fragen

Für wen ist diese Seite gedacht?
Für Personen, die eine technische Anbindung an ein externes System einrichten — typischerweise die IT-Abteilung oder ein technischer Dienstleister, da hierfür eine gültige Ziel-Adresse des externen Systems benötigt wird.

Warum lehnt SCS manche URLs ab?
Aus Sicherheitsgründen werden ausschließlich öffentlich erreichbare Adressen akzeptiert — lokale, interne oder private Netzwerkadressen (z. B. „localhost" oder Adressen aus internen Netzbereichen) sind nicht zulässig.

Was ist das Signatur-Geheimnis?
Ein geheimer Wert, mit dem das empfangende System prüfen kann, dass eine eingehende Nachricht tatsächlich von SCS stammt und nicht von einem Dritten gefälscht wurde.

Was passiert, wenn ich einen Webhook lösche?
Der Webhook und sein gesamtes Zustellprotokoll werden entfernt; es werden danach keine weiteren Benachrichtigungen mehr gesendet.

Verwandte Themen