Структура веб-хука \ Создание веб-хука
Перед созданием \ обновлением веб-хуков необходимо сохранить настройки модуля с актуальной опцией "Полный путь до веб-хука" из предыдущего раздела.
В настройках модуля отображаются все веб-хуки установленные для данного аккаунта МойСклад. Поэтому вы можете редактировать существующие веб-хуки, а также создавать новые.
Структура одного веб-хука
Давайте разберём, как работает веб-хук на примере товара, когда его создают (Сущность: product / Событие: CREATE). Из заголовка веб-хука вы видите, к какому объекту и какому действию он относится. Вот какие объекты (сущности) можно настроить для веб-хуков:
- product - простой товар
- variant - модификация
- service - услуга
- bundle - комплект
- productfolder - группа (раздел)
Исходя из ваших задач, вам не обязательно устанавливать все веб-хуки, вы можете использовать только те, что будут участвовать в вашем обмене.
Далее события веб-хука конкретной сущности бывают:
- CREATE - создание сущности. При этом событии модуль пытается создать новую сущность на сайте
- UPDATE - обновление сущности. При этом событии модуль проверяет наличие обновлений для конкретной сущности, если он найдет ее сайте.
- DELETE - удаление сущности. При этом событии модуль по умолчанию деактивирует найденную сущность на сайте.
Состояние веб-хука
Под заголовком каждой пары «сущность / событие» выводятся веб-хуки, которые уже есть в МойСклад, — их адрес и состояние:
- зелёный индикатор, «активен» — веб-хук включён, МойСклад отправляет по нему события;
- красный индикатор, «неактивен» — веб-хук выключен в МойСклад, события по нему не приходят. Проверьте, что адрес веб-хука открывается (см. Настройка URL), и включите веб-хук в МойСклад или пересоздайте его.
Если веб-хука для пары нет, выводится строка «Веб-хук … не установлен».
Кто обслуживает веб-хук
Обычно события веб-хуков обрабатывает сам модуль — в этом случае отдельной подписи нет. Если на сайте подключён собственный обработчик (доработка под ваш проект), то:
- у пары, которую обслуживает он, выводится подпись «Обслуживает внешний обработчик: …»;
- на вкладке могут появиться дополнительные сущности сверх списка выше — их добавил этот обработчик, и для них веб-хуки создаются так же.
Подробнее для разработчиков: событие OnBuildWebhookEntityList.
Создание веб-хука
Для создания нового веб-хука достаточно отметить чекбоксы "Создать" у каждой сущности и события, которые вам нужны. Далее сохранить настройки модуля. После сохранения вы увидите созданные веб-хуки.
Обновление веб-хука
Если у вас поменяется один из параметров URL веб-хука (сменится домен или проверочная строка), то создавать веб-хук не обязательно, можно обновить существующий веб-хук, который раннее создал модуль. Отметьте галочку "обновить" у нужного веб-хука и сохраните параметры модуля.
Если МойСклад не принял изменение или удаление веб-хука, текст его ошибки выводится над настройками модуля, а в списке остаётся прежний адрес — тот, что действительно записан в МойСклад.
Веб-хуки создаются в каждом профиле обмена отдельно. В адрес веб-хуков дополнительного профиля модуль сам добавляет параметр profile_id.