Webhook

Webhooks sind eine Funktion, mit der Sie Echtzeit-Benachrichtigungen erhalten, wenn bestimmte Ereignisse in BoxHero auftreten.

---

Registrierung

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

Zustell- und Wiederholungsverhalten

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

• Wenn Ihr Server mit einem beliebigen 2xx-Statuscode (z. B. 200, 201, 204) wird die Zustellung als erfolgreich behandelt.

• Jede Antwort ohne 2xx gilt als Fehler und wird erneut versucht.

Struktur der Webhook-Nutzlast

Alle Webhook-Ereignisse werden mit der folgenden JSON-Struktur im Anforderungskörper übermittelt:

{
  "id": "3f9a2b7c-6d4e-4a1f-9c8b-2e5d7a0f1b34", // Eindeutige Ereignis-ID
  "topic": "txs/new", // Ereignisthema
  "version": 1, // Version des Nutzlastschemas
  "payload": { // Ereignisspezifische Daten
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // Zeitstempel des Ereigniseintritts (ISO 8601)
}

---

Reihenfolge der Ereignisse

BoxHero garantiert nicht die Reihenfolge der Ereigniszustellung. Zum Beispiel kann ein item/new Ereignis nach einem item/delete Ereignis für dasselbe Element 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 erfolgt (Wareneingang / Warenausgang / Bestandsanpassung / Bestandsverschiebung).

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

ErforderlichErforderlichkeit

Feld	Erforderlich	Beschreibung
id		Eindeutige ID der Transaktion
type		Transaktionstyp (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		Ausgangsstandort
from_location.id		Eindeutige ID des Ausgangsstandorts
from_location.name		Name des Ausgangsstandorts
from_location.deleted		Ob der Ausgangsstandort gelöscht ist
to_location		Zielstandort
to_location.id		Eindeutige ID des Zielstandorts
to_location.name		Name des Zielstandorts
to_location.deleted		Ob der Zielstandort gelöscht ist
items		Positionen 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		Lagerbestand am Ausgangsstandort nach der Transaktion
items.to_location_new_stock_level		Lagerbestand am Zielstandort nach der Transaktion
transaction_time		Transaktionszeit (z. B. Zeitpunkt von Wareneingang/-ausgang)
created_at		Zeitpunkt der Erstellung der Transaktion
created_by		Mitglied, das die Transaktion erstellt hat
created_by.id		Eindeutige ID des Mitglieds
created_by.name		Name des Mitglieds
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 Detailseite der Transaktion
memo		Notizen zur Transaktion

Beispiel für eine 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 eine Webhook-Nutzlast – Bestandsverschiebung 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 / Bestandsverschiebung / Bestandsanpassung) ist bearbeitet.

ErforderlichErforderlichkeit

Feld	Erforderlich	Beschreibung
id		Eindeutige ID der Transaktion
type		Transaktionstyp (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		Ausgangsstandort
from_location.id		Eindeutige ID des Ausgangsstandorts
from_location.name		Name des Ausgangsstandorts
from_location.deleted		Ob der Ausgangsstandort gelöscht ist
to_location		Zielstandort
to_location.id		Eindeutige ID des Zielstandorts
to_location.name		Name des Zielstandorts
to_location.deleted		Ob der Zielstandort gelöscht ist
items		Positionen in der Transaktion
items.id		Eindeutige ID des Artikels
items.name		Artikelname
items.quantity		Mengenänderung durch die Transaktion (in/out/adjust/move)
items.deleted		Ob der Artikel gelöscht ist
items.from_location_new_stock_level		Lagerbestand am Ausgangsstandort nach der Transaktion
items.to_location_new_stock_level		Lagerbestand am Zielstandort nach der Transaktion
transaction_time		Transaktionszeit (z. B. Zeitpunkt von Wareneingang/-ausgang)
created_at		Zeitpunkt der Erstellung der Transaktion
created_by		Mitglied, das die Transaktion erstellt hat
created_by.id		Eindeutige ID des Mitglieds
created_by.name		Name des Mitglieds
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 Detailseite der Transaktion
memo		Notizen zur Transaktion
Revision		Aktuelle Versionsnummer der Transaktion, beginnend bei 1

Beispiel für eine Webhook-Nutzlast – bearbeitete Transaktion Wareneingang Transaktion

{
  "id": 16160911,
  "revision": 2,
  "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 eine Webhook-Nutzlast – bearbeitete Transaktion Bestandsverschiebung Transaktion

{
  "id": 3692714,
  "revision": 2,
  "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.

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

Beispiel für eine Webhook-Nutzlast – gelöschte Transaktion

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

item/new

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

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

Erforderlichkeit

Feld	Beschreibung
id	Artikel-ID
Name	Artikelname
SKU	SKU
Barcode	Barcode
Foto-URL	Kosten
Kosten	Preis
Preis	Preis
Attribute	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 bei Massenbearbeitungen über Datenzentrum > Artikel oder über die Import aus Excel Funktion.

Erforderlichkeit

Feld	Beschreibung
id	Artikel-ID
Name	Artikelname
SKU	SKU
Barcode	Barcode
Foto-URL	Kosten
Kosten	Preis
Preis	Preis
Attribute	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 Inventar des Teams gelöscht wird.

Hinweis: Dieses Ereignis wird nicht ausgelöst bei Massenlöschungen über Datenzentrum > Artikel.

Feld	Beschreibung
id	Artikel-ID

Beispielnutzlast – Artikel gelöscht

{
  "id": 26122826
}