> For the complete documentation index, see [llms.txt](https://www.boxhero.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.boxhero.io/docs/documentation/ru/integracii/webhook.md).

# Webhook

<figure><img src="/files/7ccbc295a24446e659e26322811677bb04807711" alt=""><figcaption></figcaption></figure>

***

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

Вы можете зарегистрировать вебхук по адресу <mark style="color:синий;">**`Настройки`**</mark> **>** <mark style="color:синий;">**`Интеграции и API`**</mark> в вашей команде BoxHero.

<figure><img src="/files/2ef009f31545bee37d286700abbbefca4a36a4a4" alt=""><figcaption></figcaption></figure>

## Поведение доставки и повторных попыток

Когда происходит событие, BoxHero отправляет HTTP `POST` запрос на вашу зарегистрированную конечную точку вебхука. Тело запроса содержит JSON-полезную нагрузку, описывающую событие.

* Если ваш сервер отвечает **HTTP 200 OK**, событие считается успешно доставленным.
* Если ваш сервер отвечает **любой статус-код, отличный от 200**, BoxHero считает это временной ошибкой и повторяет доставку до 3 раз.

## Структура полезной нагрузки вебхука

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

```json
{
  "id": "1234", // Уникальный ID события
  "topic": "txs/new", // Тема события
  "version": 1, // Версия схемы полезной нагрузки
  "payload": { // Данные, специфичные для события
    ...
  },
  "created_time": "2025-08-06T09:20:48.623Z" // Временная метка наступления события (ISO 8601)
}
```

***

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

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

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

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

{% hint style="info" %}
Если вам нужна поддержка дополнительных тем событий, обратитесь в [поддержку](/docs/documentation/ru/resursy/contact.md).
{% endhint %}

### `txs/new`

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

{% hint style="warning" %}
**Примечание:** Это событие *не* срабатывает для корректировок, созданных через массовое редактирование или импорт (например, при добавлении или обновлении товаров через Excel).
{% endhint %}

<table><thead><tr><th width="207">Поле</th><th width="100" data-type="checkbox">Обязательно</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Командный режим</th></tr></thead><tbody><tr><td>id</td><td>true</td><td>Уникальный ID транзакции</td><td>true</td><td>Уникальный ID истории</td><td>Все</td></tr><tr><td>type</td><td>true</td><td>Тип транзакции<br>(in, out, adjust, move)</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход: in</li><li>Расход: out</li><li>Корректировка: adjust</li><li>Перемещение: move</li></ul></td><td>Все</td></tr><tr><td>partner</td><td>false</td><td>Партнёр</td><td>false</td><td></td><td></td></tr><tr><td>partner.id</td><td>false</td><td>Уникальный ID партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.name</td><td>false</td><td>Имя партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.deleted</td><td>false</td><td>Удалён ли партнёр</td><td>false</td><td></td><td></td></tr><tr><td>from_location</td><td>false</td><td>Исходное местоположение</td><td>false</td><td></td><td></td></tr><tr><td>from_location.id</td><td>false</td><td>Уникальный ID исходного местоположения</td><td>false</td><td></td><td></td></tr><tr><td>from_location.name</td><td>false</td><td>Название исходного местоположения</td><td>false</td><td></td><td></td></tr><tr><td>from_location.deleted</td><td>false</td><td>Удалено ли исходное местоположение</td><td>false</td><td></td><td></td></tr><tr><td>to_location</td><td>true</td><td>Место назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.id</td><td>true</td><td>Уникальный ID места назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.name</td><td>true</td><td>Название места назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.deleted</td><td>true</td><td>Удалено ли место назначения</td><td>false</td><td></td><td></td></tr><tr><td>items</td><td>true</td><td>Позиции транзакции</td><td>true</td><td>Позиции по товарам, составляющие историю</td><td>Все режимы</td></tr><tr><td>items.id</td><td>true</td><td>Уникальный ID товара</td><td>true</td><td>Уникальный ID товара</td><td>Все режимы</td></tr><tr><td>items.name</td><td>true</td><td>Название товара</td><td>true</td><td>Название товара</td><td>Все режимы</td></tr><tr><td>items.quantity</td><td>true</td><td>Изменение запасов из-за прихода/расхода/корректировки/перемещения</td><td>true</td><td>Количество прихода/расхода/корректировки/перемещения для данного товара</td><td>Все режимы</td></tr><tr><td>items.deleted</td><td>true</td><td>Удалён ли товар</td><td>true</td><td>Удалён ли товар</td><td></td></tr><tr><td>items.from_location_new_stock_level</td><td>false</td><td>Остаток на исходном месте после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>items.to_location_new_stock_level</td><td>true</td><td>Остаток в месте назначения после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>transaction_time</td><td>true</td><td>Время транзакции (например, время прихода/расхода)</td><td>false</td><td></td><td></td></tr><tr><td>created_at</td><td>true</td><td>Время создания транзакции</td><td>false</td><td></td><td></td></tr><tr><td>created_by</td><td>true</td><td>Участник, создавший транзакцию</td><td>false</td><td></td><td></td></tr><tr><td>created_by.id</td><td>true</td><td>Уникальный ID участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.name</td><td>true</td><td>Имя участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.deleted</td><td>true</td><td>Удалён ли участник</td><td>false</td><td></td><td></td></tr><tr><td>count_of_items</td><td>true</td><td>Количество товаров</td><td>false</td><td></td><td></td></tr><tr><td>total_quantity</td><td>true</td><td>Общее количество изменения запасов</td><td>false</td><td></td><td></td></tr><tr><td>url</td><td>true</td><td>URL-адрес для просмотра страницы деталей транзакции</td><td>false</td><td></td><td></td></tr><tr><td>memo</td><td>false</td><td>Примечания, связанные с транзакцией</td><td>false</td><td></td><td></td></tr></tbody></table>

#### Пример полезной нагрузки вебхука — `Приход` Событие

```json
{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Склад 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"
}
```

#### Пример полезной нагрузки вебхука — `Перемещение запасов` Событие

<pre class="language-json"><code class="lang-json">{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Склад 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Склад 3",
<strong>    "deleted": false
</strong>  },
  "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"
}
</code></pre>

### `txs/edit`

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

<table><thead><tr><th>Поле</th><th width="100" data-type="checkbox">Обязательно</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Командный режим</th></tr></thead><tbody><tr><td>id</td><td>true</td><td>Уникальный ID транзакции</td><td>true</td><td>Уникальный ID истории</td><td>Все</td></tr><tr><td>type</td><td>true</td><td>Тип транзакции<br>(in, out, adjust, move)</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход: in</li><li>Расход: out</li><li>Корректировка: adjust</li><li>Перемещение: move</li></ul></td><td>Все</td></tr><tr><td>partner</td><td>false</td><td>Партнёр</td><td>false</td><td></td><td></td></tr><tr><td>partner.id</td><td>false</td><td>Уникальный ID партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.name</td><td>false</td><td>Имя партнёра</td><td>false</td><td></td><td></td></tr><tr><td>partner.deleted</td><td>false</td><td>Удалён ли партнёр</td><td>false</td><td></td><td></td></tr><tr><td>from_location</td><td>false</td><td>Исходное местоположение</td><td>false</td><td></td><td></td></tr><tr><td>from_location.id</td><td>false</td><td>Уникальный ID исходного местоположения</td><td>false</td><td></td><td></td></tr><tr><td>from_location.name</td><td>false</td><td>Название исходного местоположения</td><td>false</td><td></td><td></td></tr><tr><td>from_location.deleted</td><td>false</td><td>Удалено ли исходное местоположение</td><td>false</td><td></td><td></td></tr><tr><td>to_location</td><td>true</td><td>Место назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.id</td><td>true</td><td>Уникальный ID места назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.name</td><td>true</td><td>Название места назначения</td><td>false</td><td></td><td></td></tr><tr><td>to_location.deleted</td><td>true</td><td>Удалено ли место назначения</td><td>false</td><td></td><td></td></tr><tr><td>items</td><td>true</td><td>Позиции транзакции</td><td>true</td><td>Позиции по товарам, составляющие историю</td><td>Все режимы</td></tr><tr><td>items.id</td><td>true</td><td>Уникальный ID товара</td><td>true</td><td>Уникальный ID товара</td><td>Все режимы</td></tr><tr><td>items.name</td><td>true</td><td>Название товара</td><td>true</td><td>Название товара</td><td>Все режимы</td></tr><tr><td>items.quantity</td><td>true</td><td>Изменение количества из-за транзакции (in/out/adjust/move)</td><td>true</td><td>Количество прихода/расхода/корректировки/перемещения для данного товара</td><td>Все режимы</td></tr><tr><td>items.deleted</td><td>true</td><td>Удалён ли товар</td><td>true</td><td>Удалён ли товар</td><td></td></tr><tr><td>items.from_location_new_stock_level</td><td>false</td><td>Остаток на исходном месте после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>items.to_location_new_stock_level</td><td>true</td><td>Остаток в месте назначения после транзакции</td><td>false</td><td></td><td></td></tr><tr><td>transaction_time</td><td>true</td><td>Время транзакции (например, время прихода/расхода)</td><td>false</td><td></td><td></td></tr><tr><td>created_at</td><td>true</td><td>Время создания транзакции</td><td>false</td><td></td><td></td></tr><tr><td>created_by</td><td>true</td><td>Участник, создавший транзакцию</td><td>false</td><td></td><td></td></tr><tr><td>created_by.id</td><td>true</td><td>Уникальный ID участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.name</td><td>true</td><td>Имя участника</td><td>false</td><td></td><td></td></tr><tr><td>created_by.deleted</td><td>true</td><td>Удалён ли участник</td><td>false</td><td></td><td></td></tr><tr><td>count_of_items</td><td>true</td><td>Количество товаров</td><td>false</td><td></td><td></td></tr><tr><td>total_quantity</td><td>true</td><td>Общее количество изменения запасов</td><td>false</td><td></td><td></td></tr><tr><td>url</td><td>true</td><td>URL-адрес для просмотра страницы деталей транзакции</td><td>false</td><td></td><td></td></tr><tr><td>memo</td><td>false</td><td>Примечания, связанные с транзакцией</td><td>false</td><td></td><td></td></tr><tr><td>revision</td><td>true</td><td>Текущий номер версии транзакции, начиная с 1</td><td>false</td><td></td><td></td></tr></tbody></table>

#### Пример полезной нагрузки вебхука — Изменённая транзакция `Приход` Транзакция

```json
{
  "id": 16160911,
  "type": "in",
  "to_location": {
    "id": 52766,
    "name": "Склад 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"
}

```

#### Пример полезной нагрузки вебхука — Изменённая транзакция `Перемещение запасов` Транзакция

```json
{
  "id": 3692714,
  "type": "move",
  "from_location": {
    "id": 52765,
    "name": "Склад 2",
    "deleted": false
  },
  "to_location": {
    "id": 52766,
    "name": "Склад 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`

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

{% hint style="warning" %}
**Примечание**: Это событие *не* срабатывает при использовании <mark style="color:синий;">**`Добавление вариантов товара`**</mark> функции или при импорте товаров через <mark style="color:синий;">**`Импорт Excel`**</mark>.
{% endhint %}

<table><thead><tr><th width="318">Поле</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Командный режим</th></tr></thead><tbody><tr><td>id</td><td>ID товара</td><td>true</td><td>Уникальный ID истории</td><td>Все</td></tr><tr><td>name</td><td>Название товара</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход: in</li><li>Расход: out</li><li>Корректировка: adjust</li><li>Перемещение: move</li></ul></td><td>Все</td></tr><tr><td>sku</td><td>SKU</td><td>false</td><td></td><td></td></tr><tr><td>barcode</td><td>Штрихкод</td><td>false</td><td></td><td></td></tr><tr><td>photo_url</td><td>URL фотографии</td><td>false</td><td></td><td></td></tr><tr><td>cost</td><td>Себестоимость</td><td>false</td><td></td><td></td></tr><tr><td>price</td><td>Цена</td><td>false</td><td></td><td></td></tr><tr><td>attrs</td><td>Атрибуты</td><td>false</td><td></td><td></td></tr></tbody></table>

#### **Пример полезной нагрузки — Товар создан**

```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": "Категория",
      "type": "text",
      "value": "Тональная основа"
    },
    {
      "id": 459264,
      "name": "Срок годности",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Страховой запас",
      "type": "number",
      "value": 33
    }
  ]
}
```

### `item/edit`

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

{% hint style="warning" %}
**Примечание**: Это событие *не* срабатывает *f*или при массовом редактировании через <mark style="color:синий;">**`Центр данных`**</mark>**&#x20;>&#x20;**<mark style="color:синий;">**`Товар`**</mark> или через <mark style="color:синий;">**`Импорт Excel`**</mark> функцию.
{% endhint %}

<table><thead><tr><th width="318">Поле</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Командный режим</th></tr></thead><tbody><tr><td>id</td><td>ID товара</td><td>true</td><td>Уникальный ID истории</td><td>Все</td></tr><tr><td>name</td><td>Название товара</td><td>true</td><td><p>Тип истории.</p><ul><li>Приход: in</li><li>Расход: out</li><li>Корректировка: adjust</li><li>Перемещение: move</li></ul></td><td>Все</td></tr><tr><td>sku</td><td>SKU</td><td>false</td><td></td><td></td></tr><tr><td>barcode</td><td>Штрихкод</td><td>false</td><td></td><td></td></tr><tr><td>photo_url</td><td>URL фотографии</td><td>false</td><td></td><td></td></tr><tr><td>cost</td><td>Себестоимость</td><td>false</td><td></td><td></td></tr><tr><td>price</td><td>Цена</td><td>false</td><td></td><td></td></tr><tr><td>attrs</td><td>Атрибуты</td><td>false</td><td></td><td></td></tr></tbody></table>

#### **Пример полезной нагрузки — Товар обновлён**

```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": "Категория",
      "type": "text",
      "value": "Тональная основа"
    },
    {
      "id": 459264,
      "name": "Срок годности",
      "type": "date",
      "value": "2027-08-07"
    },
    {
      "id": 668272,
      "name": "Страховой запас",
      "type": "number",
      "value": 33
    }
  ]
}
```

### `item/delete`

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

{% hint style="warning" %}
**Примечание**: Это событие *не* срабатывает при массовом удалении через <mark style="color:синий;">**`Центр данных`**</mark>**&#x20;>&#x20;**<mark style="color:синий;">**`Товар`**</mark>.
{% endhint %}

<table><thead><tr><th width="318">Поле</th><th>Описание</th><th data-hidden data-type="checkbox">Обязательность</th><th data-hidden>Описание</th><th data-hidden>Командный режим</th></tr></thead><tbody><tr><td>id</td><td>ID товара</td><td>true</td><td>Уникальный ID истории</td><td>Все</td></tr></tbody></table>

#### Пример полезной нагрузки **— Товар удалён**

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