Webhook destination
Renta отправляет события, собранные Renta Tracker, на ваш HTTP-эндпоинт: один запрос на событие с JSON-телом, которое вы собираете из полей события.
Вы выбираете тип и имя события, добавляете фильтры и сопоставляете поля события с ключами тела. Renta отправляет каждое подходящее событие сразу после его получения.
Требования к эндпоинту
Эндпоинт должен принимать запросы, которые Renta отправляет при проверке подключения и при доставке.
- URL с протоколом.
Хост начинается сhttp://илиhttps://. - HTTP 200 на тестовый запрос.
При сохранении подключения Renta отправляет на хост один запрос с выбранным методом и заголовками и пустым телом. Renta сохраняет подключение, только если эндпоинт отвечает статусом 200 в течение 10 секунд. Любой другой статус, включая 201 и 204, не проходит проверку. - Статус 2xx при доставке.
Каждое событие отправляется отдельным зап росом с теми же методом и заголовками и JSON-телом. Любой статус от 200 до 299 считается доставкой. Любой другой статус помечает запуск как неудавшийся. - Доступность из интернета.
Renta отправляет запросы со своих IP-адресов. Если эндпоинт закрыт списком разрешённых адресов, добавьте в него IP-адреса Renta.
Аутентификация
Renta аутентифицируется на вашем эндпоинте заголовками, которые вы добавляете в подключение. Каждый запрос, включая тестовый, содержит их.
Обычный вариант: секрет в собственном заголовке, например x-webhook-secret, который эндпоинт сравнивает со своим значением.
Подключение Webhook destination
- Перейдите в раздел Connections > Catalog в левом боковом меню.
- Откройте категорию Event stream и нажмите карточку Webhook с пометкой Destination.
В категории есть и карточка Webhooks с пометкой Source. Этот коннектор принимает события в Renta и описан на странице источника Webhooks.
Заполните поля и нажмите Save.
| Поле | Описание |
|---|---|
| Destination name | Имя подключения в интерфейсе Renta. |
| Hostname | Полный URL эндпоинта с протоколом, например https://example.com/renta/events. |
| Webhook sending method | HTTP-метод каждого запроса: GET, POST, PUT или DELETE. Выберите POST, чтобы передавать событие в теле запроса. |
| Headers | Включите переключатель и добавьте пары ключ и значение. Renta добавляет их в каждый запрос. Нажмите Add field, чтобы добавить ещё один заголовок. |
Renta отправляет тестовый запрос и сохраняет подключение, когда эндпоинт отвечает статусом 200. Если проверка не прошла, подключение не сохраняется. Сверьте статус, который вернул ваш эндпоинт, с таблицей ниже.
| Статус ответа эндпоинта | Что проверить |
|---|---|
| 401 или 403 | Значения заголовков не совпадают с тем, что ожидает эндпоинт. Проверьте секрет и имя заголовка. |
| 404 | Такого пути нет. Проверьте хост, включая путь после домена. |
| 405 | Эндпоинт не принимает выбранный метод. Измените Webhook sending method или разрешите метод на эндпоинте. |
| 500 | Эндпоинт упал при обработке запроса. Чаще всего он разбирает тело, не проверив, что оно пустое. |
| Нет ответа | Renta не смогла достучаться до хоста за 10 секунд. Проверьте DNS, список разрешённых адресов и что сервис запущен. |
Создание пайплайна Webhook
Назначение Webhook и источник Renta Tracker должны существовать до начала.
В левом боковом меню нажмите New pipeline. На шаге Source выберите источник Renta Tracker в блоке Already connected и нажмите Next step. Затем выберите подключение источника и нажмите Next step.
На шаге Destination выберите Webhook в блоке Already connected, выберите созданное подключение и нажмите Next step.
Выберите Event Type и Event names, которые запускают отправку. Добавьте Filters, чтобы отправлять только события, свойства которых подходят под условие, например конкретную страницу или минимальную сумму заказа.
Добавьте строку для каждого ключа JSON-тела: имя ключа и поле события, которое его заполняет. Доступны поля верхнего уровня и свойства события. Нажмите Save, чтобы активировать пайплайн.
Доставка
Renta отправляет запрос для каждого события, которое подходит под пайплайн, сразу после того, как Renta Tracker получает событие.
Тело содержит только ключи, которые вы сопоставили. Ключ, у которого поле события пустое, в тело не попадает, поэтому эндпоинт не получает значений null. Renta добавляет заголовок User-Agent: renta.im 2.0, если вы не задали свой User-Agent в подключении.
Каждый запрос является запуском пайплайна. В запуске видны статус и текст ответа эндпоинта, поэтому отклонённое событие отображается в мониторинге пайплайнов вместе с причиной. Renta не повторяет неудавшуюся доставку.
Ограничения
Renta не ограничивает число назначений Webhook и пайплайнов в воркспейсе. Эндпоинт получает один запрос на событие, поэтому убедитесь, что он выдерживает частоту событий вашего сайта.
Ready to get started?
Build your data pipeline today or get a personalized demo. Start free!
Need help?
Get expert support to ensure your project succeeds. We're here to help!
Feature requests?
Help shape our product! Share your ideas for new features and integrations.