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

Как настроить исходящий вебхук

Настройка отправки событий Aplaut на ваш URL в разделе «Интеграции»: подготовка приёмника, подключение, проверка доставки

Настройте исходящий вебхук, если ваша система должна реагировать на события Aplaut: начислять бонусы за отзыв, прошедший модерацию, обновлять карточку товара, заводить задачу по новому вопросу. При наступлении события Aplaut отправляет на ваш URL запрос POST с телом в формате JSON.

Что понадобится​

  • Роль Менеджер или Администратор: раздел Интеграции открыт только для них.
  • URL приёмника на вашей стороне, принимающий POST с телом JSON.
  • Список событий и типов контента — см. справочник по событиям вебхуков.

Шаг 1. Подготовьте приёмник на своей стороне​

  1. Отвечайте кодом 2xx: только такую доставку Aplaut считает успешной. На остальные коды и на таймаут отправка повторяется, поэтому сделайте обработку идемпотентной. В каждом запросе приходят заголовки X-Aplaut-Event с именем события и X-Aplaut-Delivery с идентификатором доставки — по второму удобно отсекать повторы.
  2. Принимайте все поля выбранного типа контента. Фильтры и выбор полей не поддерживаются: Aplaut отправляет полный набор данных.
  3. Решите, как приёмник опознаёт запросы от Aplaut: по секрету в поле secret тела запроса или по секрету в заголовке, имя которого задаёте вы. Если приёмник ничего не проверяет, секрет можно не заводить.

Шаг 2. Создайте подключение​

  1. Откройте раздел Интеграции, нажмите Подключить интеграцию и выберите в каталоге Исходящий вебхук.
  2. Введите Название — по нему вы найдёте подключение в списке и в журнале запусков.
  3. В блоке Учётные данные выберите Способ авторизации. Секретная строка уедет в поле secret тела запроса. При выборе Секрет в заголовке укажите Название заголовка (по умолчанию X-Api-Key) и сам секрет — тогда поля secret в теле не будет. Блок можно оставить пустым.
  4. В блоке Параметры укажите URL получателя и выберите События. Одно подключение можно подписать на несколько событий.
  5. Остальные параметры оставьте как есть, если у приёмника нет особых требований: Тип контента json, Формат данных attributes (в нём приведены примеры в справочнике), Таймаут, сек. от 1 до 5, Не проверять SSL-сертификат. Отдельно про Игнорировать ошибки доставки: с этой настройкой Aplaut не повторяет неудачную отправку, но запись в журнале всё равно помечается ошибкой.
  6. Включите тумблер Включена и нажмите Подключить.

Шаг 3. Разрешите адреса Aplaut​

Если приёмник закрыт фильтром по IP, запросите актуальный список адресов у менеджера или в чате технической поддержки и добавьте их в список разрешённых. Без этого запросы не дойдут до вашего сервиса, а в журнале запусков появятся ошибки доставки.

Проверка результата​

Выполните действие, которое вызывает выбранное событие — например, опубликуйте тестовый отзыв через модерацию. Затем в разделе Интеграции нажмите в шапке списка кнопку со значком часов — Журнал запусков — и выберите своё подключение в фильтре. Успешная доставка попадает туда со статусом Выполнен, неудачная — со статусом Ошибка и текстом ответа получателя. Записи хранятся 90 дней.

примечание

Вебхуки, настроенные раньше через менеджера, работают по-прежнему, но в разделе Интеграции не показываются. Если вы завели то же событие и тот же URL заново, попросите менеджера выключить старый вебхук: иначе приёмник получит два одинаковых запроса.

Смотрите также​