Перейти к основному содержимому

Структура веб-хука \ Создание веб-хука

к сведению

Перед созданием \ обновлением веб-хуков необходимо сохранить настройки модуля с актуальной опцией "Полный путь до веб-хука" из предыдущего раздела.

В настройках модуля отображаются все веб-хуки установленные для данного аккаунта МойСклад. Поэтому вы можете редактировать существующие веб-хуки, а также создавать новые.

Структура одного веб-хука

image_1

Давайте разберём, как работает веб-хук на примере товара, когда его создают (Сущность: product / Событие: CREATE). Из заголовка веб-хука вы видите, к какому объекту и какому действию он относится. Вот какие объекты (сущности) можно настроить для веб-хуков:

  • product - простой товар
  • variant - модификация
  • service - услуга
  • bundle - комплект
  • productfolder - группа (раздел)

Исходя из ваших задач, вам не обязательно устанавливать все веб-хуки, вы можете использовать только те, что будут участвовать в вашем обмене.

Далее события веб-хука конкретной сущности бывают:

  • CREATE - создание сущности. При этом событии модуль пытается создать новую сущность на сайте
  • UPDATE - обновление сущности. При этом событии модуль проверяет наличие обновлений для конкретной сущности, если он найдет ее сайте.
  • DELETE - удаление сущности. При этом событии модуль по умолчанию деактивирует найденную сущность на сайте.

Создание веб-хука

Для создания нового веб-хука достаточно отметить чекбоксы "Создать" у каждой сущности и события, которые вам нужны. Далее сохранить настройки модуля. После сохранения вы увидите созданные веб-хуки.

Обновление веб-хука

Если у вас поменяется один из параметров URL веб-хука (сменится домен или проверочная строка), то создавать веб-хук не обязательно, можно обновить существующий веб-хук, который раннее создал модуль. Отметье галочку "обновить" у нужного веб-хука и сохрание параметры модуля.