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

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

• Редактировать существующие веб-хуки
• Создавать новые веб-хуки

Важно!

Редактируйте только те веб-хуки, где указан адрес вашего сайта. Другие веб-хуки работают от других приложений — их трогать не нужно.

Что делать:

• Первая установка модуля — создавайте новые веб-хуки
• Веб-хуки уже созданы — при изменении URL или проверочной строки обновляйте существующие веб-хуки модуля

Тип выполнения веб-хука

Новая функция

Опция доступна с версии 3.0.0. В ней реализован функционал очереди задач для выполнения веб-хуков.

Данная опция настраивается для каждого веб-хука отдельно. Это позволяет точечно выбирать, какие веб-хуки выполнять моментально, а какие — в очереди.

Варианты выполнения веб-хука

1. Выполнять моментально

• Веб-хук выполняется сразу же при получении

2. Выполнять отложенно в очереди

• Веб-хук направляется в очередь и выполняется поэтапно
• Преимущество: нет ограничений на количество изменяемых сущностей

3. Первый элемент моментально, остальные в очереди

• Смешанный режим выполнения
• При получении нескольких сущностей: первая обрабатывается сразу, остальные добавляются в очередь

Как работает очередь веб-хуков?

Шаг 1: Настройка после обновления

После обновления до версии 3.0.0:

1. Зайдите в настройки модуля
2. Сохраните настройки

Это создаст:

• Нужные таблицы для очередей
• Новый агент \Rbs\Moysklad\Agent::webhook_tasker_worker() для обработки очереди

Шаг 2: Работа системы

Когда хотя бы один веб-хук настроен на выполнение в очереди:

• Все изменения из МойСклад для этого веб-хука добавляются в очередь
• Агент запускается каждую минуту и обрабатывает изменения
• Все действия логируются в разделе диагностики

Обязательный веб-хук

Обязательно для работы модуля

Для первичной настройки модуля необходимо установить веб-хук:

• Сущность: customerorder
• Событие: UPDATE

Этот веб-хук отслеживает изменения заказов в МойСклад и передает их на сайт.

После установки веб-хук появится в списке:

Изменение настроек веб-хука

Для изменения URL или проверочной строки:

1. Измените настройки в разделе выше
2. Сохраните модуль
3. Нажмите галочку "Обновить" напротив веб-хуков, созданных модулем

Дополнительные веб-хуки

Импорт заказов

Веб-хук: customerorder / CREATE

Когда нужен

Устанавливайте этот веб-хук, если хотите импортировать заказы из МойСклад на сайт.

Настройки: находятся во вкладке "Импорт заказа"

Управление платежами

Веб-хуки для входящих платежей:

• paymentin / CREATE, UPDATE, DELETE

Веб-хуки для приходных ордеров:

• cashin / CREATE, UPDATE, DELETE

Когда нужны

Устанавливайте эти веб-хуки, если во вкладке "Оплаты" выбран тип обмена оплатами full.

Важно: устанавливайте сразу все три события (CREATE, UPDATE, DELETE) для каждой сущности.

Управление отгрузками

Веб-хуки: demand / CREATE, UPDATE

Когда нужны

Устанавливайте эти веб-хуки, если во вкладке "Отгрузки" выбран тип обмена отгрузками full.

Важно: устанавливайте сразу оба события (CREATE, UPDATE).