Как настроить исходящий вебхук
Настройка отправки событий Aplaut на ваш URL в разделе Инструменты → Интеграции: подготовка приёмника, подключение, проверка доставки
Настройте исходящий вебхук, если ваша система должна реагировать на события Aplaut: начислять бонусы за отзыв, прошедший модерацию, обновлять карточку товара, заводить задачу по новому вопросу. При наступлении события Aplaut отправляет на ваш URL запрос POST с телом в формате JSON.
Что понадобится
- Роль Менеджер или Администратор: раздел Инструменты → Интеграции открыт только для них.
- URL приёмника на вашей стороне, принимающий
POSTс телом JSON. - Список событий и типов контента — см. справочник по событиям вебхуков.
Шаг 1. Подготовьте приёмник на своей стороне
- Отвечайте кодом 2xx: только такую доставку Aplaut считает успешной. На остальные коды и на таймаут отправка повторяется, поэтому сделайте обработку идемпотентной. В каждом запросе приходят заголовки
X-Aplaut-Eventс именем события иX-Aplaut-Deliveryс идентификатором доставки — по второму удобно отсекать повторы. - Принимайте все поля выбранного типа контента. Фильтры и выбор полей не поддерживаются: Aplaut отправляет полный набор данных.
- Решите, как приёмник опознаёт запросы от Aplaut: по секрету в поле
secretтела запроса или по секрету в заголовке, имя которого задаёте вы. Имя заголовка — латинские буквы, цифры и знаки!#$%&'*+-.^_`|~без пробелов; служебные заголовкиHost,Content-Length,Content-Type,Transfer-Encoding,Connection,User-Agent,Accept-Encoding,X-Aplaut-EventиX-Aplaut-Deliveryзаняты. Если приёмник ничего не проверяет, секрет можно не заводить.
Шаг 2. Создайте подключение
-
Откройте Инструменты → Интеграции, нажмите Подключить интеграцию и выберите в каталоге Исходящий вебхук.
-
Введите Название — по нему вы найдёте подключение в списке и в журнале запусков.
-
В блоке Учётные данные выберите сохранённый секрет из списка или нажмите Создать новый и выберите Тип учётных данных:
- Секретная строка — значение поля Секрет уедет в поле
secretтела запроса; - Секрет в заголовке — укажите Название заголовка (по умолчанию
X-Api-Key) и Секрет. Секрет уедет в этом заголовке, а поляsecretв теле не будет. Перевод строки в секрете недопустим.
Если приёмник ничего не проверяет, выберите Не использовать или оставьте блок пустым.
- Секретная строка — значение поля Секрет уедет в поле
-
В блоке Параметры укажите URL получателя и выберите События — в списке они названы по-русски, например Публикация отзыва; соответствие кодам событий — в справочнике. Одно подключение можно подписать на несколько событий.
-
Остальные параметры оставьте как есть, если у приёмника нет особых требований: Тип контента
json, Формат данныхattributes(в нём приведены примеры в справочнике), Таймаут, сек. от 1 до 5, Не проверять SSL-сертификат. Отдельно про Игнорировать ошибки доставки: с этой настройкой Aplaut не повторяет неудачную отправку, но запись в журнале всё равно помечается ошибкой. -
Включите тумблер Включена и нажмите Подключить.
Шаг 3. Разрешите адреса Aplaut
Если приёмник закрыт фильтром по IP, запросите актуальный список адресов у менеджера или в чате технической поддержки и добавьте их в список разрешённых. Без этого запросы не дойдут до вашего сервиса, а в журнале запусков появятся ошибки доставки.
Проверка результата
Выполните действие, которое вызывает выбранное событие — например, опубликуйте тестовый отзыв через модерацию. Затем в разделе Инструменты → Интеграции нажмите в шапке списка значок Журнал запусков и выберите своё подключение в фильтре. Успешная доставка попадает туда со статусом Выполнен, неудачная — со статусом Ошибка и текстом ответа получателя. Записи хранятся 90 дней.
Вебхуки, которые раньше настраивал менеджер Aplaut или вы сами в настройках компании, работают по-прежнему. Они собраны в разделе Админ → Устаревшее → Вебхуки — он доступен ролям Менеджер и Администратор, группа Устаревшее в меню свёрнута. В разделе Инструменты → Интеграции такие вебхуки не показываются. Если вы завели то же событие и тот же URL заново через Исходящий вебхук, удалите старый вебхук: иначе приёмник получит два одинаковых запроса.
Смотрите также
- Справочник: события и структура вебхуков — полный перечень событий, служебные поля и примеры тел запросов.