Webhooks

Webhooks ermöglichen es, dass externe Parteien/Apps auf Ereignisse in Stoqflow reagieren. Eine webhook ist eine URL, die von Stoqflow bei einem bestimmten Ereignis aufgerufen wird. Die externe Partei kann dann entsprechende Aktionen unternehmen, basierend auf der bereitgestellten Informationen.

Über Einstellungen > Webhooks können Webhooks erstellt und verwaltet werden. Eine webhook besteht aus einer Auslöser, optionalen Filtern und einer URL und kann permanent aktiviert oder innerhalb eines bestimmten Zeitraums (zum Beispiel zur Einholung von Webhooks für Bestellungen während eines zeitweiligen kommerziellen Angebots) aktiviert werden.

Felder

Auslöser

Für jede webhook muss ein Auslöser ausgewählt werden. Eine Ereignis, bei dem sich geprüft wird, ob die webhook aufgerufen werden soll. Einige wichtige Auslöser sind zum Beispiel:

  • Wenn eine Bestellung erstellt wurde
  • Wenn Vorratsbestände aktualisiert wurden
  • ...

Filtre

Filtre sind optional und können verwendet werden, um zu prüfen, ob die webhook aufgerufen werden soll. So kann beispielsweise eine webhook nur dann aufgerufen werden, wenn der Bestellung an ein bestimmtes Land verschickt wird oder das Produkt einer bestimmten Handelsmarke zugeordnet ist. Das Order/Produkt/etc. muss alle Filter erfüllen, bevor die Webhook aufgerufen wird.

URL

Die URL, die aufgerufen wird, wenn die webhook aktiviert wird. Diese URL muss vom Internet aus zugänglich sein und der externe Dienst sollte in der Lage sein, die bereitgestellten Informationen zu verarbeiten.

Wann werden Webhooks aufgerufen?

Webhooks werden immer nachdem der Auslöser der Webhook in der Datenbank gespeichert wurde. Das bedeutet, wenn eine webhook bei der Bearbeitung einer Bestellung aufgerufen wird, werden die übermittelten Daten die aktualisierten Daten des geänderten Orders enthalten, einschließlich aller Änderungen, die während der Bearbeitung vorgenommen wurden.

Technische Details

Webhooks werden über einen HTTP POST-Request an die bereitgestellte URL aufgerufen. Die übermittelten Daten sind ein JSON-Objekt, das alle Daten enthält, die die Webhook ausgelöst haben.

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

Die Webhook-Request enthält zusätzliche Header:

  • X-Hook-Trigger: Der Auslöser der Webhook
  • X-Company-Id: Die Identifikation des Unternehmens innerhalb von Stoqflow, zu dem die übermittelten Daten gehören. Dies kann zum Beispiel verwendet werden, um weitere API-Anfragen durchzuführen.

!> Nach 5 aufeinanderfolgenden negativen Antworten der bereitgestellten URL wird die Webhook automatisch deaktiviert. Die Webhook kann manuell wieder aktiviert werden, indem sie über die Webhook-Einstellungen geändert wird.