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

Настройка URL веб-хука

Обозначения в документации

Далее адрес https://site.ru будет обозначать адрес вашего сайта.

Полный путь до веб-хука​

Веб-хук файл — это специальный PHP-файл, который автоматически копируется при установке модуля и обрабатывает входящие запросы от МойСклад.

Стандартное расположение​

По умолчанию файл веб-хука располагается по адресу:

https://site.ru/mshooks/hook.php

Если поле «Полный путь до веб-хука» ещё не сохранялось, модуль подставляет в него этот адрес сам — по протоколу и домену, на котором открыты настройки. Проверьте, что подставился именно публичный адрес сайта: если настройки открыты по техническому домену или IP, исправьте значение вручную.

Проверка доступности​

Как проверить, что веб-хук работает:

  1. Откройте в браузере адрес: https://site.ru/mshooks/hook.php
  2. Вы должны увидеть пустую страницу — это означает, что файл доступен и работает корректно
Важные требования
  • Файл должен открываться с HTTP статусом 200
  • Не должно быть редиректов при обращении к файлу
  • Страница должна загружаться без ошибок сервера

Настройка пользовательского пути​

Гибкость размещения

Вы можете перемещать файл hook.php в любое удобное место на вашем сервере.

Если вы переместили файл веб-хука:

  1. Укажите новый полный путь в настройках модуля
  2. Обновите все веб-хуки модуля для применения изменений (см. Изменение настроек веб-хука)
  3. Проверьте доступность по новому адресу

Пример пользовательского пути​

https://site.ru/custom/folder/my-webhook.php

Дополнительная проверка веб-хука​

Проверочная строка — это механизм безопасности для идентификации и защиты веб-хука от несанкционированных запросов. МойСклад не подписывает свои веб-хуки, поэтому проверочная строка — единственное, по чему модуль отличает настоящее уведомление от постороннего запроса.

Как это устроено:

  • При создании или обновлении веб-хука модуль добавляет проверочную строку к адресу в параметре checkUrl, например https://site.ru/mshooks/hook.php?checkUrl=...
  • При получении уведомления модуль сравнивает переданную строку с сохранённой в настройках. Не совпала — запрос молча отклоняется и в журнал не пишется
  • Если поле пустое, модуль при открытии вкладки сам генерирует случайную строку из 32 символов. Она сохраняется вместе с настройками модуля
  • Пока строка не сохранена, модуль не принимает ни одного веб-хука
Критически важно

Проверочная строка во всех настроенных веб-хуках должна совпадать с сохранённой в настройках. Несовпадение приведет к отказу в обработке запросов.

Если вы изменили проверочную строку, обновите все веб-хуки модуля — иначе МойСклад продолжит присылать уведомления со старой строкой, и модуль будет их отклонять.

Рекомендации
  • Не используйте в качестве проверочной строки домен сайта, дату или другое легко угадываемое значение — оставьте сгенерированную модулем строку или задайте свою длинную случайную
  • Не публикуйте адрес веб-хука вместе с параметром checkUrl
  • Проверочная строка не попадает в резервную копию настроек модуля: при восстановлении на сайте остаётся его собственная строка. Перенесли настройки на другой сайт — проверьте строку на нём и обновите веб-хуки

Решение проблем​

Если у вас возникли проблемы с веб-хуками, изучите специальный раздел документации:

📚 Частые проблемы при настройке веб-хука