Перейти к содержимому
Помощь
Русский
Настройки магазина

Вебхуки

Настройте уведомления о событиях в реальном времени, отправляемые на конечную точку API или адрес электронной почты при возникновении сессий, заказов или обновлений заказов в вашем магазине.

Что делают вебхуки

Вебхук: подписка на определённое событие магазина. При возникновении этого события Storeep немедленно отправляет данные на указанный вами URL (API тип) или адрес электронной почты (E-mail тип). Вебхуки широко используются для интеграций отслеживания заказов, синхронизации CRM, конверсий рекламных платформ и автоматических уведомлений.

Для управления вебхуками перейдите в Настройки → Вебхуки.

Лимиты вебхуков

  • Максимум 20 вебхуков на магазин. Попытка добавить 21-й вернёт ошибку.
  • Вебхуки перечислены от новейших к старейшим, с разбивкой на страницы по 40 штук.

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

Нажмите Добавить новый вебхук.

Переключатель активации

При отмеченном флажке (по умолчанию) вебхук работает с момента сохранения. События отправляются немедленно. Снимите флажок, чтобы сохранить вебхук в отключённом состоянии без получения событий. Вы можете включить или отключить вебхук в любое время путём редактирования.

Название

  • Обязательное поле.
  • Максимум 50 символов.
  • Информативная метка, отображаемая в списке вебхуков. Например: Facebook CAPI, заказ создан.

Тип

Управляет способом доставки полезной нагрузки события. Два варианта:

  • API: Storeep отправляет HTTP POST-запрос с данными события на указанный URL.
  • E-mail: Storeep отправляет email с данными события на указанный адрес.

Событие

Событие магазина, запускающее данный вебхук. Доступны три события:

  • Сессия создана: срабатывает при создании новой сессии посетителя в магазине.
  • Заказ создан: срабатывает при размещении нового заказа.
  • Заказ обновлён: срабатывает при изменении статуса или данных существующего заказа.

Формат

Формат данных полезной нагрузки события. В настоящее время один вариант:

  • Json: полезная нагрузка отправляется как JSON-документ.

URL (только для типа API)

  • Обязательное поле при типе API.
  • Максимум 500 символов. Увеличенный лимит учитывает URL с несколькими сегментами-заполнителями.
  • Введите URL конечной точки без префикса https://. Он добавляется автоматически. Например: api.example.com/events/order.
  • Динамические заполнители URL: любое поле из полезной нагрузки события можно вставить в URL с помощью синтаксиса двойных скобок: {{field_name}}. Например:
    https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
    Это позволяет отправлять данные о конверсиях на рекламные платформы непосредственно из URL вебхука без отдельного прокси-сервера.
  • Если структура URL после подстановки заполнителей некорректна, вы получите ошибку валидации.

Адрес электронной почты (только для типа E-mail)

  • Обязательное поле при типе E-mail.
  • Должен быть корректным email-адресом, максимум 127 символов.

Редактирование вебхука

Нажмите на любую строку вебхука для открытия редактора. Все поля доступны для редактирования. Поле URL предзаполняется только если текущий тип: API; поле email предзаполняется только если текущий тип: E-mail. Переключение типа очищает другое поле.

Включение и отключение вебхуков

Флажок Активировать в верхней части редактора управляет тем, срабатывает ли вебхук. В списке отображается статус Активирован или Деактивирован. Отключённый вебхук не фиксирует доставки, но не удаляется, поэтому его можно повторно включить без перенастройки.

Столбцы списка вебхуков

  • Название: метка вебхука с датой создания.
  • URL / E-mail: адрес назначения.
  • Тип: API или E-mail.
  • Событие: название события (Сессия создана, Заказ создан или Заказ обновлён).
  • Формат: Json.
  • Статус: Активирован или Деактивирован.

Удаление вебхука

Выберите один или несколько вебхуков и нажмите Удалить вебхуки. Это необратимо и прекращает все будущие доставки для данной подписки.

Советы и возможные проблемы

  • Вы можете создать несколько вебхуков для одного события, например отправить Заказ создан одновременно в CRM и на рекламную платформу, каждый как отдельная запись вебхука.
  • Если вашей конечной точке требуется аутентификация, добавьте учётные данные в строку запроса URL с помощью {{заполнителя}} из данных события, или настройте прокси-сервер, обрабатывающий аутентификацию перед пересылкой на реальную конечную точку.
  • Событие Сессия создана срабатывает для каждой уникальной сессии посетителя, что может давать большой объём для популярных магазинов. Подписывайтесь на него только если ваша конечная точка способна справиться с такой нагрузкой.