> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Every page is available as Markdown by appending `.md` to its URL; this page is [Markdown](https://www.boxhero.io/docs/de/integrations/webhook.md).

# Webhook

> Mit Webhooks erhalten Sie Echtzeit-Benachrichtigungen, sobald bestimmte Ereignisse in BoxHero eintreten.

![](https://assets.boxhero.io/docs/images/e073efd69a551d1c50313ce8969f89656fe7fb6c2f4bf97cd67eb7398f4e21d6-1601x941.jpeg)

---

## Registrierung

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

![](https://assets.boxhero.io/docs/images/39738e2bf18459a1ba1d9df4c6a3eb786fc434f5fab37932e8edf50bf6a0b91a-1100x810.png)

## Zustellung und Wiederholungsversuche

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

- Antwortet Ihr Server mit einem beliebigen **2xx-Statuscode** (z. B. 200, 201, 204), gilt die Zustellung als erfolgreich.
- Jede **Antwort außerhalb des 2xx-Bereichs** gilt als Fehlschlag, und die Zustellung wird erneut versucht.

## Aufbau der Webhook-Nutzlast

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

```json
{
  "id": "3f9a2b7c-6d4e-4a1f-9c8b-2e5d7a0f1b34", // Event's unique ID
  "topic": "txs/new", // Event topic
  "version": 1, // Payload schema version
  "payload": { // Event-specific data
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // Timestamp of event occurrence (ISO 8601)
}
```

---

## Reihenfolge der Ereignisse

BoxHero garantiert die Reihenfolge der Ereigniszustellung **nicht**. Beispielsweise kann ein `item/new`-Ereignis nach einem `item/delete`-Ereignis für denselben Artikel eintreffen.

Das Feld `created_time` in der Ereignis-Nutzlast gibt den tatsächlichen Zeitpunkt des Ereignisses an. Implementieren Sie in Ihrem Webhook-Handler eine idempotente, reihenfolgeunabhängige Logik, um Ereignisse zuverlässig zu verarbeiten.

## Ereignisthemen

> **Note**
>
> Wenn Sie Unterstützung für weitere Ereignisthemen benötigen, wenden Sie sich bitte an den [Support](https://www.boxhero.io/docs/de/resources/contact).

### txs/new

Wird ausgelöst, wenn eine Bestandstransaktion erfolgt (Wareneingang / Warenausgang / Anpassung / Verschieben).

> **Caution**
>
> **Hinweis:** Dieses Ereignis wird _nicht_ für Anpassungen ausgelöst, die durch Massenbearbeitungen oder Importe entstehen (z. B. beim Hinzufügen oder Aktualisieren von Artikeln per Excel).

| 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 wurde |
| from_location |  | Ausgangsstandort |
| from_location.id |  | Eindeutige ID des Ausgangsstandorts |
| from_location.name |  | Name des Ausgangsstandorts |
| from_location.deleted |  | Ob der Ausgangsstandort gelöscht wurde |
| to_location | ✓ | Zielstandort |
| to_location.id | ✓ | Eindeutige ID des Zielstandorts |
| to_location.name | ✓ | Name des Zielstandorts |
| to_location.deleted | ✓ | Ob der Zielstandort gelöscht wurde |
| items | ✓ | Positionen der Transaktion |
| items.id | ✓ | Eindeutige ID des Artikels |
| items.name | ✓ | Artikelname |
| items.quantity | ✓ | Bestandsänderung durch Wareneingang/Warenausgang/Anpassung/Verschieben |
| items.deleted | ✓ | Ob der Artikel gelöscht wurde |
| items.from_location_new_stock_level |  | Bestand am Ausgangsstandort nach der Transaktion |
| items.to_location_new_stock_level | ✓ | Bestand am Zielstandort nach der Transaktion |
| transaction_time | ✓ | Transaktionszeitpunkt (z. B. Zeitpunkt des Wareneingangs/Warenausgangs) |
| created_at | ✓ | 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 | ✓ | Name des Mitglieds |
| created_by.deleted | ✓ | Ob das Mitglied gelöscht wurde |
| count_of_items | ✓ | Anzahl der Artikel |
| total_quantity | ✓ | Gesamtmenge der Bestandsänderung |
| url | ✓ | URL der Detailseite der Transaktion |
| memo |  | Notizen zur Transaktion |

#### Beispiel-Webhook-Nutzlast – Stock In-Ereignis

```json
{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Warehouse 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-Webhook-Nutzlast – Move Stock-Ereignis

```json
{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Warehouse 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Warehouse 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 bestehende Bestandstransaktion (Wareneingang / Warenausgang / Verschieben / Anpassung) **bearbeitet** wird.

| 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 wurde |
| from_location |  | Ausgangsstandort |
| from_location.id |  | Eindeutige ID des Ausgangsstandorts |
| from_location.name |  | Name des Ausgangsstandorts |
| from_location.deleted |  | Ob der Ausgangsstandort gelöscht wurde |
| to_location | ✓ | Zielstandort |
| to_location.id | ✓ | Eindeutige ID des Zielstandorts |
| to_location.name | ✓ | Name des Zielstandorts |
| to_location.deleted | ✓ | Ob der Zielstandort gelöscht wurde |
| items | ✓ | Positionen 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 wurde |
| items.from_location_new_stock_level |  | Bestand am Ausgangsstandort nach der Transaktion |
| items.to_location_new_stock_level | ✓ | Bestand am Zielstandort nach der Transaktion |
| transaction_time | ✓ | Transaktionszeitpunkt (z. B. Zeitpunkt des Wareneingangs/Warenausgangs) |
| created_at | ✓ | 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 | ✓ | Name des Mitglieds |
| created_by.deleted | ✓ | Ob das Mitglied gelöscht wurde |
| count_of_items | ✓ | Anzahl der Artikel |
| total_quantity | ✓ | Gesamtmenge der Bestandsänderung |
| url | ✓ | URL der Detailseite der Transaktion |
| memo |  | Notizen zur Transaktion |
| revision | ✓ | Aktuelle Versionsnummer der Transaktion, beginnend bei 1 |

#### Beispiel-Webhook-Nutzlast – bearbeitete Stock In-Transaktion

```json
{
  "id": 16160911,
  "revision": 2,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Warehouse 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-Webhook-Nutzlast – bearbeitete Move Stock-Transaktion

```json
{
  "id": 3692714,
  "revision": 2,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Warehouse 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Warehouse 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 Bestandstransaktion **gelöscht** wird.

| Feld | Beschreibung |
| --- | --- |
| id | Eindeutige ID der Transaktion |
| revision | Aktuelle Versionsnummer der Transaktion, beginnend bei 1 |

#### Beispiel-Webhook-Nutzlast – gelöschte Transaktion

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

### item/new

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

> **Caution**
>
> **Hinweis**: Dieses Ereignis wird _nicht_ ausgelöst, wenn Sie die Funktion `Artikelvarianten hinzufügen` verwenden oder Artikel über `Excel importieren` importieren.

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

#### Beispiel-Nutzlast – Artikel erstellt

```json
{
  "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": "Category",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Expiration date",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}
```

### item/edit

Wird gesendet, wenn ein bestehender Artikel bearbeitet wird.

> **Caution**
>
> **Hinweis**: Dieses Ereignis wird _nicht_ für Massenbearbeitungen ausgelöst, die über `Datenzentrum` > `Artikel` oder über die Funktion `Excel importieren` vorgenommen werden.

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

#### Beispiel-Nutzlast – Artikel aktualisiert

```json
{
  "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": "Category",
      "type": "text",
      "value": "Foundation"
    },
    {
      "id": 459264,
      "name": "Expiration date",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Safety Stock",
      "type": "number",
      "value": 33
    }
  ]
}
```

### item/delete

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

> **Caution**
>
> **Hinweis**: Dieses Ereignis wird _nicht_ für Massenlöschungen ausgelöst, die über `Datenzentrum` > `Artikel` vorgenommen werden.

| Feld | Beschreibung |
| --- | --- |
| id | Artikel-ID |

#### Beispiel-Nutzlast – Artikel gelöscht

```json
{
  "id": 26122826
}
```
