Webhook

Webhooks sind Funktionen, mit denen Sie Echtzeitbenachrichtigungen erhalten, wenn bestimmte Ereignisse in BoxHero auftreten.

---

Registrierung

Sie können einen Webhook unter Einstellungen > Integrationen & API in Ihrem BoxHero-Team.

Zustell- und Wiederholungsverhalten

Wenn ein Ereignis auftritt, sendet BoxHero eine HTTP POST Anfrage an Ihren registrierten Webhook-Endpunkt. Der Anfrage-Body enthält eine JSON-Nutzlast, die das Ereignis beschreibt.

• Wenn Ihr Server mit HTTP 200 OKantwortet, gilt das Ereignis als erfolgreich zugestellt.

• Wenn Ihr Server mit jeder Nicht-200-Statuscodebehandelt BoxHero dies als vorübergehenden Fehler und versucht die Zustellung bis zu 3 Mal erneut.

Struktur der Webhook-Nutzlast

Alle Webhook-Ereignisse werden mit der folgenden JSON-Struktur im Anfrage-Body zugestellt:

{
  "id": "1234", // Eindeutige ID des Ereignisses
  "topic": "txs/new", // Ereignisthema
  "version": 1, // Version des Nutzlastschemas
  "payload": { // Ereignisspezifische Daten
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // Zeitstempel des Ereigniszeitpunkts (ISO 8601)
}

---

Ereignisreihenfolge

BoxHero garantiert nicht die Reihenfolge der Ereigniszustellung. Zum Beispiel kann ein item/new Ereignis nach einem item/delete Ereignis für denselben Artikel eintreffen.

Das created_time Feld in der Ereignisnutzlast repräsentiert die tatsächliche Ereigniszeit. Implementieren Sie in Ihrem Webhook-Handler idempotente und reihenfolgetolerante Logik, um Ereignisse zuverlässig zu verarbeiten.

Ereignisthemen

Wenn Sie Unterstützung für zusätzliche Ereignisthemen benötigen, wenden Sie sich bitte an Support.

txs/new

Wird ausgelöst, wenn eine Lagertransaktion auftritt (Wareneingang / Warenausgang / Lager anpassen / Bestand verschieben).

Hinweis: Dieses Ereignis ist nicht ausgelöst für Anpassungen, die durch Massenbearbeitungen oder Importe erstellt wurden (z. B. beim Hinzufügen oder Aktualisieren von Artikeln per Excel).

ErforderlichErforderlichkeit

Feld	Erforderlich	Beschreibung
id		Eindeutige ID der Transaktion
type		Transaktionstyp\n(in, out, adjust, move)
partner		Partner
partner.id		Eindeutige ID des Partners
partner.name		Name des Partners
partner.deleted		Ob der Partner gelöscht ist
from_location		Quellort
from_location.id		Eindeutige ID des Quellorts
from_location.name		Name des Quellorts
from_location.deleted		Ob der Quellort gelöscht ist
to_location		Zielort
to_location.id		Eindeutige ID des Zielorts
to_location.name		Name des Zielorts
to_location.deleted		Ob der Zielort gelöscht ist
items		Positionszeilen in der Transaktion
items.id		Eindeutige ID des Artikels
items.name		Artikelname
items.quantity		Bestandsänderung durch Wareneingang/-ausgang/Anpassung/Verschiebung
items.deleted		Ob der Artikel gelöscht ist
items.from_location_new_stock_level		Der Lagerbestand am Quellort nach der Transaktion
items.to_location_new_stock_level		Der Lagerbestand am Zielort nach der Transaktion
transaction_time		Transaktionszeit (z. B. Wareneingangs-/Warenausgangszeit)
created_at		Der Zeitpunkt, zu dem die Transaktion erstellt wurde
created_by		Mitglied, das die Transaktion erstellt hat
created_by.id		Eindeutige ID des Mitglieds
created_by.name		Mitgliedsname
created_by.deleted		Ob das Mitglied gelöscht ist
count_of_items		Anzahl der Artikel
total_quantity		Gesamthöhe der Bestandsänderung
url		URL-Adresse zur Anzeige der Transaktionsdetailseite
memo		Hinweise zur Transaktion

Beispiel für Webhook-Nutzlast – Wareneingang Ereignis

{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Lager 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}

Beispiel für Webhook-Nutzlast – Bestand verschieben Ereignis

{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Lager 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Lager 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2025-04-25T05:42:27.545Z",
  "created_at": "2025-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Tony Lee",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

txs/edit

Wird gesendet, wenn eine vorhandene Lagertransaktion (Wareneingang / Warenausgang / Lager anpassen / Bestand verschieben) wird bearbeitet.

ErforderlichErforderlichkeit

Feld	Erforderlich	Beschreibung
id		Eindeutige ID der Transaktion
type		Transaktionstyp\n(in, out, adjust, move)
partner		Partner
partner.id		Eindeutige ID des Partners
partner.name		Name des Partners
partner.deleted		Ob der Partner gelöscht ist
from_location		Quellort
from_location.id		Eindeutige ID des Quellorts
from_location.name		Name des Quellorts
from_location.deleted		Ob der Quellort gelöscht ist
to_location		Zielort
to_location.id		Eindeutige ID des Zielorts
to_location.name		Name des Zielorts
to_location.deleted		Ob der Zielort gelöscht ist
items		Positionszeilen in der Transaktion
items.id		Eindeutige ID des Artikels
items.name		Artikelname
items.quantity		Mengenänderung aufgrund der Transaktion (in/out/adjust/move)
items.deleted		Ob der Artikel gelöscht ist
items.from_location_new_stock_level		Der Lagerbestand am Quellort nach der Transaktion
items.to_location_new_stock_level		Der Lagerbestand am Zielort nach der Transaktion
transaction_time		Transaktionszeit (z. B. Wareneingangs-/Warenausgangszeit)
created_at		Der Zeitpunkt, zu dem die Transaktion erstellt wurde
created_by		Mitglied, das die Transaktion erstellt hat
created_by.id		Eindeutige ID des Mitglieds
created_by.name		Mitgliedsname
created_by.deleted		Ob das Mitglied gelöscht ist
count_of_items		Anzahl der Artikel
total_quantity		Gesamthöhe der Bestandsänderung
url		URL-Adresse zur Anzeige der Transaktionsdetailseite
memo		Hinweise zur Transaktion
Revision		Aktuelle Versionsnummer der Transaktion, beginnend bei 1

Beispiel für Webhook-Nutzlast – Bearbeitet Wareneingang Transaktion

{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Lager 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14277699,
      "name": "belif Cleansing Gel Oil Enriched",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 3
    },
    {
      "id": 14277698,
      "name": "belif Aqua Bomb Jelly Cleanser",
      "quantity": 2,
      "deleted": false,
      "to_location_new_stock_level": 5
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-08-14T05:14:29.499Z",
  "created_by": {
    "id": 201345,
    "name": "corp",
    "deleted": false
  },
  "count_of_items": 2,
  "total_quantity": 4,
  "url": "https://web.boxhero-app.com/team/149058/mode/0#/tx/16160911"
}

Beispiel für Webhook-Nutzlast – Bearbeitet Bestand verschieben Transaktion

{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Lager 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Lager 3",
    "deleted": false
  },
  "items": [
    {
      "id": 14873303,
      "name": "Auto liner 3.5mm",
      "quantity": 1,
      "deleted": false,
      "from_location_new_stock_level": -1,
      "to_location_new_stock_level": 1
    }
  ],
  "transaction_time": "2023-04-25T05:42:27.545Z",
  "created_at": "2023-04-25T05:42:27.545Z",
  "created_by": {
    "id": 176829,
    "name": "Joy Kim",
    "deleted": false
  },
  "count_of_items": 1,
  "total_quantity": 1,
  "url": "https://web.boxhero-app.com/team/150581/mode/2#/ltx/3692714"
}

txs/delete

Wird gesendet, wenn eine Lagertransaktion gelöscht wird.

Feld	Beschreibung
id	Eindeutige ID der Transaktion
Revision	Aktuelle Versionsnummer der Transaktion, beginnend bei 1

Beispiel für Webhook-Nutzlast – Gelöschte Transaktion

/{
  "id": 27036740,
  "revision": 2
}

item/new

Wird gesendet, wenn ein neuer Artikel zum Bestand des Teams hinzugefügt wird.

Hinweis: Dieses Ereignis wird nicht ausgelöst, wenn die Artikelvarianten hinzufügen Funktion verwendet wird oder Artikel über Excel-Import.

Erforderlichkeit

Feld	Beschreibung
id	Artikel-ID
name	Artikelname
sku	SKU
barcode	Barcode
photo_url	Foto-URL
cost	Kosten
price	Preis
attrs	Attribute

Beispielnutzlast – Artikel erstellt

{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Kategorie",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Ablaufdatum",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Sicherheitsbestand",
      "type": "number",
      "value": 33
    }
  ]
}

item/edit

Wird gesendet, wenn ein vorhandener Artikel bearbeitet wird.

Hinweis: Dieses Ereignis wird nicht ausgelöst foder Massenbearbeitungen, die über Data Center > Artikel oder über die Excel-Import Funktion.

Erforderlichkeit

Feld	Beschreibung
id	Artikel-ID
name	Artikelname
sku	SKU
barcode	Barcode
photo_url	Foto-URL
cost	Kosten
price	Preis
attrs	Attribute

Beispielnutzlast – Artikel aktualisiert

{
  "id": 26122826,
  "name": "belif Peat Miracle Revital Cream",
  "sku": "SKU-YH2361KI",
  "barcode": "2002074321218",
  "photo_url": "https://d3l9wd8kivvlqy.cloudfront.net/ap-northeast-2/image-up-ap-northeast-2/30b0cc84-601d-493d-87fd-b7e8b5825601",
  "cost": "50000",
  "price": "65000",
  "attrs": [
    {
      "id": 413101,
      "name": "Kategorie",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Ablaufdatum",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Sicherheitsbestand",
      "type": "number",
      "value": 33
    }
  ]
}

item/delete

Wird gesendet, wenn ein Artikel aus dem Bestand des Teams gelöscht wird.

Hinweis: Dieses Ereignis wird nicht ausgelöst für Massenlöschungen, die über Data Center > Artikel.

Feld	Beschreibung
id	Artikel-ID

Beispielnutzlast – Artikel gelöscht

{
  "id": 26122826
}