Доступ и настройка
Вебхуки настраиваются в админ-панели. Доступ — у администратора магазина; отдельный API-токен для настройки не нужен. Ваша задача как разработчика — подготовить URL-обработчик, передать его администратору (или настроить самому, если есть доступ к админке) и сохранить секрет подписи.
Где находится
Откройте «Настройки приложения» → вкладка «Вебхуки». Внутри две вкладки:
- События — список всех событий и подписки на них.
- Журнал — история доставок (см. Использование).
Подписка на событие
В таблице событий каждая строка — одно событие. Для подписки нажмите «Настроить» (или «Редактировать», если подписка уже есть) и заполните:
| Поле | Описание |
|---|---|
| URL подписчика |
Адрес, на который приходят запросы. Должен начинаться с http:// или https://. Для боевого использования — только https://. |
| Таймаут (мс) | Сколько ждать ответ от вашего сервера. Не меньше 500 мс. Максимум зависит от режима: для sync — 30000 мс, для async — 300000 мс. |
| Повторов при ошибке | Сколько раз повторить доставку async-события при ошибке (0–10). Для sync-событий повторы не используются. |
| Описание | Внутренняя заметка для администраторов: куда и зачем идёт вебхук. |
| Активна | Если выключить — конфигурация сохраняется, но события не отправляются. |
Дефолтный таймаут подставляется автоматически: для большинства sync-событий —
5000 мс, для catalog.bonus.calculate — 2000 мс (листинг каталога критичен по
скорости), для async-событий — 60000 мс.
Секрет подписи
Каждой подпиской подписываются её запросы (HMAC-SHA256). Секрет нужен, чтобы на вашей стороне проверить подлинность запроса — см. Проверка подписи.
- При создании подписки секрет генерируется автоматически и показывается один раз — скопируйте его сразу.
- Позже секрет можно посмотреть действием «Секрет» в строке события.
- Чтобы заменить секрет, при редактировании включите «Сгенерировать новый секрет». После ротации старый секрет перестаёт действовать — обновите его на своей стороне.
Проверка вебхука
Кнопка «Тест» в строке события отправляет на ваш URL тестовый запрос и показывает результат: HTTP-статус и время ответа. Используйте её, чтобы убедиться, что обработчик доступен и корректно проверяет подпись, ещё до реальных событий.
Удаление подписки
Кнопка «Удалить» убирает подписку на событие. Конфигурация и секрет удаляются; события по этому адресу больше не отправляются.
Связанные разделы
- Использование — конверт запроса, проверка подписи, контракт ответа.
- Вебхуки — обзор
- OpenAPI документация — схемы полей событий.