> 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/ru/integrations/webhook.md).

# Webhook

> Вебхуки позволяют получать уведомления в реальном времени, когда в BoxHero происходят определённые события.

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

---

## Регистрация

Зарегистрировать вебхук можно в разделе `Настройки` > `Интеграции` вашей команды BoxHero.

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

## Доставка и повторные попытки

При наступлении события BoxHero отправляет HTTP-запрос `POST` на зарегистрированный адрес вебхука. Тело запроса содержит JSON-данные с описанием события.

- Если ваш сервер отвечает **любым кодом статуса 2xx** (например, 200, 201, 204), доставка считается успешной.
- **Любой ответ с кодом, отличным от 2xx,** считается ошибкой, и доставка будет повторена.

## Структура данных вебхука

Все события вебхука доставляются со следующей JSON-структурой в теле запроса:

```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)
}
```

---

## Порядок событий

BoxHero **не** гарантирует порядок доставки событий. Например, событие `item/new` может прийти после события `item/delete` для того же товара.

Поле `created_time` в данных события содержит фактическое время события. Чтобы надёжно обрабатывать события, реализуйте в обработчике вебхука идемпотентную логику, не зависящую от порядка поступления событий.

## Темы событий

> **Note**
>
> Если вам нужна поддержка других тем событий, обратитесь в [службу поддержки](https://www.boxhero.io/docs/ru/resources/contact).

### txs/new

Срабатывает при создании складской транзакции (Приход / Расход / Корректировка / Перемещение).

> **Caution**
>
> **Примечание:** это событие _не_ срабатывает для корректировок, созданных при массовом редактировании или импорте (например, при добавлении или обновлении товаров через Excel).

| Поле | Обязательно | Описание |
| --- | --- | --- |
| id | ✓ | Уникальный ID транзакции |
| type | ✓ | Тип транзакции (in, out, adjust, move) |
| partner |  | Контрагент |
| partner.id |  | Уникальный ID контрагента |
| partner.name |  | Название контрагента |
| partner.deleted |  | Удалён ли контрагент |
| from_location |  | Исходное место хранения |
| from_location.id |  | Уникальный ID исходного места хранения |
| from_location.name |  | Название исходного места хранения |
| from_location.deleted |  | Удалено ли исходное место хранения |
| to_location | ✓ | Целевое место хранения |
| to_location.id | ✓ | Уникальный ID целевого места хранения |
| to_location.name | ✓ | Название целевого места хранения |
| to_location.deleted | ✓ | Удалено ли целевое место хранения |
| items | ✓ | Позиции товаров в транзакции |
| items.id | ✓ | Уникальный ID товара |
| items.name | ✓ | Название товара |
| items.quantity | ✓ | Изменение остатка в результате прихода/расхода/корректировки/перемещения |
| items.deleted | ✓ | Удалён ли товар |
| items.from_location_new_stock_level |  | Остаток в исходном месте хранения после транзакции |
| items.to_location_new_stock_level | ✓ | Остаток в целевом месте хранения после транзакции |
| transaction_time | ✓ | Время транзакции (например, время прихода/расхода) |
| created_at | ✓ | Время создания транзакции |
| created_by | ✓ | Участник, создавший транзакцию |
| created_by.id | ✓ | Уникальный ID участника |
| created_by.name | ✓ | Имя участника |
| created_by.deleted | ✓ | Удалён ли участник |
| count_of_items | ✓ | Количество товаров |
| total_quantity | ✓ | Общее изменение остатка |
| url | ✓ | URL-адрес страницы с подробностями транзакции |
| memo |  | Примечания к транзакции |

#### Пример данных вебхука – событие Stock In

```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"
}
```

#### Пример данных вебхука – событие Move Stock

```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

Отправляется, когда существующая складская транзакция (Приход / Расход / Перемещение / Корректировка) **изменена**.

| Поле | Обязательно | Описание |
| --- | --- | --- |
| id | ✓ | Уникальный ID транзакции |
| type | ✓ | Тип транзакции (in, out, adjust, move) |
| partner |  | Контрагент |
| partner.id |  | Уникальный ID контрагента |
| partner.name |  | Название контрагента |
| partner.deleted |  | Удалён ли контрагент |
| from_location |  | Исходное место хранения |
| from_location.id |  | Уникальный ID исходного места хранения |
| from_location.name |  | Название исходного места хранения |
| from_location.deleted |  | Удалено ли исходное место хранения |
| to_location | ✓ | Целевое место хранения |
| to_location.id | ✓ | Уникальный ID целевого места хранения |
| to_location.name | ✓ | Название целевого места хранения |
| to_location.deleted | ✓ | Удалено ли целевое место хранения |
| items | ✓ | Позиции товаров в транзакции |
| items.id | ✓ | Уникальный ID товара |
| items.name | ✓ | Название товара |
| items.quantity | ✓ | Изменение количества в результате транзакции (приход/расход/корректировка/перемещение) |
| items.deleted | ✓ | Удалён ли товар |
| items.from_location_new_stock_level |  | Остаток в исходном месте хранения после транзакции |
| items.to_location_new_stock_level | ✓ | Остаток в целевом месте хранения после транзакции |
| transaction_time | ✓ | Время транзакции (например, время прихода/расхода) |
| created_at | ✓ | Время создания транзакции |
| created_by | ✓ | Участник, создавший транзакцию |
| created_by.id | ✓ | Уникальный ID участника |
| created_by.name | ✓ | Имя участника |
| created_by.deleted | ✓ | Удалён ли участник |
| count_of_items | ✓ | Количество товаров |
| total_quantity | ✓ | Общее изменение остатка |
| url | ✓ | URL-адрес страницы с подробностями транзакции |
| memo |  | Примечания к транзакции |
| revision | ✓ | Номер текущей версии транзакции, начиная с 1 |

#### Пример данных вебхука – изменённая транзакция Stock In

```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"
}

```

#### Пример данных вебхука – изменённая транзакция Move Stock

```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

Отправляется, когда складская транзакция **удалена**.

| Поле | Описание |
| --- | --- |
| id | Уникальный ID транзакции |
| revision | Номер текущей версии транзакции, начиная с 1 |

#### Пример данных вебхука – удалённая транзакция

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

### item/new

Отправляется, когда в остатки команды добавлен новый товар.

> **Caution**
>
> **Примечание**: это событие _не_ срабатывает при использовании функции `Массовое добавление модификаций` и при импорте товаров через `Импорт из Excel`.

| Поле | Описание |
| --- | --- |
| id | ID товара |
| name | Название товара |
| sku | Артикул |
| barcode | Штрихкод |
| photo_url | URL фото |
| cost | Себестоимость |
| price | Цена |
| attrs | Атрибуты |

#### Пример данных – товар создан

```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

Отправляется при изменении существующего товара.

> **Caution**
>
> **Примечание**: это событие _не_ срабатывает при массовом редактировании в разделе `Управление данными` > `Товар` и при использовании функции `Импорт из Excel`.

| Поле | Описание |
| --- | --- |
| id | ID товара |
| name | Название товара |
| sku | Артикул |
| barcode | Штрихкод |
| photo_url | URL фото |
| cost | Себестоимость |
| price | Цена |
| attrs | Атрибуты |

#### Пример данных – товар изменён

```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

Отправляется при удалении товара из остатков команды.

> **Caution**
>
> **Примечание**: это событие _не_ срабатывает при массовом удалении в разделе `Управление данными` > `Товары`.

| Поле | Описание |
| --- | --- |
| id | ID товара |

#### Пример данных – товар удалён

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