Webhooks

Webhooks ermöglichen es, dass externe Parteien/Anwendungen auf Ereignisse innerhalb von Webship Online reagieren können. Ein Webhook ist eine URL, die von Webship Online ausgelöst wird, wenn ein bestimmtes Ereignis stattfindet. Die externe Partei kann dann die notwendigen Aktionen durchführen, basierend auf der in dem Webhook bereitgestellten Informationen.

Über Einstellungen > Webhooks können Webhooks erstellt und verwaltet werden. Ein Webhook besteht aus einem Auslöser, einigen optionalen Filtrationen und einer URL und kann permanent aktiviert werden oder innerhalb eines angegebenen Zeitfensters (z.B. nur Webhooks auf Bestellungen aufrufen, wenn eine zeitlich begrenzte kommerzielle Aktion stattfindet).

Felder

Auslöser

Für jede Webhook muss ein Auslöser ausgewählt werden. Ein Ereignis, bei dem geprüft wird, ob die Webhooks aktiviert werden müssen. Einige wichtige Auslöser sind zum Beispiel:

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

Filter

Filter sind optional und können verwendet werden, um zu bestimmen, ob ein Webhook aktiviert werden sollte oder nicht. Ein Webhook kann beispielsweise nur aktiviert werden, wenn die Bestellung in ein bestimmtes Land verschickt wird oder das Produkt einer bestimmten Handelsmarke zugeordnet ist. Die Bestellung/Produkt/... muss alle Filter im Webhook erfüllen, bevor sie aktiviert wird.

URL

Die URL, die ausgelöst wird, wenn der Webhook aktiviert wird. Diese URL muss vom Internet aus zugänglich sein und die externe Partei muss in der Lage sein, die bereitgestellten Informationen zu verarbeiten.

Wann werden Webhooks aktiviert?

Webhooks werden immer nachdem der Auslöser des Webhooks in der Datenbank festgehalten wurde. Dies bedeutet, dass wenn ein Webhook ausgelöst wird, während eine Bestellung bearbeitet wird, die bereitgestellte Daten die Daten sind von der geänderten Bestellung, einschließlich aller Änderungen, die in der Bearbeitung vorgenommen wurden.

Technische Details

Webhooks werden über einen HTTP-POST-Antrag an die angegebene URL ausgelöst. Die Daten, die im Webhook bereitgestellt werden, sind ein JSON-Objekt, das die Daten enthält, auf denen der Webhook basiert.

?> Bitte beachten Sie unsere API-Dokumentation für weitere Informationen über die Struktur der verschiedenen Objekte, die in Webhooks bereitgestellt werden können.

Der Webhook-Antrag enthält folgende zusätzliche Header:

  • X-Hook-Trigger: Der Auslöser des Webhooks
  • X-Company-Id: Die Identifier des Unternehmens innerhalb von Webship Online, zu dem die bereitgestellten Daten gehören. Diese kann verwendet werden, um beispielsweise zusätzliche API-Anfragen auszuführen.

!> Nach 5 aufeinanderfolgenden negativen Antworten der angegebenen URL wird der Webhook automatisch deaktiviert. Der Webhook kann manuell wieder aktiviert werden, über die Webhook-Einstellungen.