Webhooks

Webhooks ermöglichen es, externe Parteien/Anwendungen zu informieren, wenn bestimmte Ereignisse innerhalb von Webship Online stattfinden. Eine webhook ist eine URL, die von Webship Online aufgerufen wird, wenn ein bestimmtes Ereignis eintritt. Die externe Partei kann dann entsprechende Maßnahmen ergreifen, basierend auf der Information, die in der webhook bereitgestellt wird.

Über Einstellungen > Webhooks können Webhooks erstellt und verwaltet werden. Eine webhook besteht aus einer Trigger-Einstellung, einigen optionalen Filters und einer URL und kann permanent aktiviert werden oder innerhalb eines bestimmten Zeitrahmens (zum Beispiel, um nur Webhooks bei Bestellungen einzurufen, wenn eine zeitliche Werbekampagne läuft).

Felder

Trigger-Einstellungen

Für jede webhook muss eine Trigger-Einstellung ausgewählt werden. Ein Ereignis, bei dem geprüft wird, ob die webhook aufgerufen werden soll. Einige wichtige Trigger sind zum Beispiel:

  • Wenn eine Bestellung erstellt wird
  • Wenn die Lagerbestände aktualisiert werden
  • ...

Filters

Filters sind optional und können verwendet werden, um zu bestimmen, ob die webhook aufgerufen werden soll oder nicht. So kann beispielsweise eine webhook nur dann aufgerufen werden, wenn der Bestellort in ein bestimmtes Land liegt oder das Produkt einem bestimmten Händler gehört. Das Bestell-/Produkt... muss an allen Filters in der webhook erfüllen, bevor es aufgerufen wird.

URL

Die URL, die aufgerufen wird, wenn die webhook aktiviert wird. Diese URL muss über das Internet erreichbar sein und die externe Partei muss in der Lage sein, die bereitgestellte Information zu verarbeiten.

Wann werden Webhooks aufgerufen?

Webhooks werden immer nach dem Übertragen der Trigger-Einstellung in der Datenbank ausgeführt. Das bedeutet, dass wenn eine webhook bei der Bearbeitung einer Bestellung aufgerufen wird, die an die externe Partei übermittelte Daten die Daten des geänderten Bestellzustands sind, einschließlich aller Änderungen, die während der Bearbeitung vorgenommen wurden.

Technische Details

Webhooks werden über eine HTTP-POST-Anforderung aufgerufen. Die bereitgestellte Daten ist ein JSON-Objekt, das die Daten enthält, die die webhook ausgelöst haben.

Die Webhook-Anforderung enthält zusätzliche Kopfzeilen:

  • X-Hook-Trigger: Die Trigger-Einstellung der webhook
  • X-Company-Id: Die Identifier des Unternehmens innerhalb von Webship Online, zu dem die übermittelten Daten gehören

?> Die X-Company-Id kann verwendet werden, um zusätzliche API-Anforderungen auszuführen, wenn erforderlich.