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

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

Настройка отправки событий 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 тела запроса или по секрету в заголовке, имя которого задаёте вы. Имя заголовка — латинские буквы, цифры и знаки !#$%&'*+-.^_`|~ без пробелов; служебные заголовки Host, Content-Length, Content-Type, Transfer-Encoding, Connection, User-Agent, Accept-Encoding, X-Aplaut-Event и X-Aplaut-Delivery заняты. Если приёмник ничего не проверяет, секрет можно не заводить.

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

  1. Откройте Инструменты → Интеграции, нажмите Подключить интеграцию и выберите в каталоге Исходящий вебхук.

  2. Введите Название — по нему вы найдёте подключение в списке и в журнале запусков.

  3. В блоке Учётные данные выберите сохранённый секрет из списка или нажмите Создать новый и выберите Тип учётных данных:

    • Секретная строка — значение поля Секрет уедет в поле secret тела запроса;
    • Секрет в заголовке — укажите Название заголовка (по умолчанию X-Api-Key) и Секрет. Секрет уедет в этом заголовке, а поля secret в теле не будет. Перевод строки в секрете недопустим.

    Если приёмник ничего не проверяет, выберите Не использовать или оставьте блок пустым.

  4. В блоке Параметры укажите URL получателя и выберите События — в списке они названы по-русски, например Публикация отзыва; соответствие кодам событий — в справочнике. Одно подключение можно подписать на несколько событий.

  5. Остальные параметры оставьте как есть, если у приёмника нет особых требований: Тип контента json, Формат данных attributes (в нём приведены примеры в справочнике), Таймаут, сек. от 1 до 5, Не проверять SSL-сертификат. Отдельно про Игнорировать ошибки доставки: с этой настройкой Aplaut не повторяет неудачную отправку, но запись в журнале всё равно помечается ошибкой.

  6. Включите тумблер Включена и нажмите Подключить.

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

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

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

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

Вебхуки, заведённые раньше

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

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