Вебхуки для API, у которого их нет
Внутренняя CRM, учётная система, площадка без уведомлений. Если у системы есть HTTP API с JSON-ответом, HookPilot опросит его сам, вычленит новые элементы и отдаст их в ваши эндпоинты как обычные вебхуки.
Бесплатный тариф без карты: одно подключение и 10 000 событий в месяц.
Как подключить
Каждое подключение опрашивает один адрес и считается одним подключением.
- 1
Создайте подключение с коннектором «Опрос HTTP API (JSON)» и укажите адрес API. Внутренние адреса и редиректы запрещены.
- 2
Укажите путь до списка элементов в ответе, например data.items, и путь до идентификатора элемента, по нему считается дедупликация.
- 3
Задайте тип события фиксированно или путём до поля в элементе. Настройте курсор: имя параметра запроса и путь до значения в ответе или элементе.
- 4
Добавьте заголовок авторизации, если API его требует, выберите расписание и подпишите эндпоинты на тип события.
Как устроен опрос
Курсор всего опроса и курсор элемента
Курсор из ответа применяется, только если доставлен весь батч. Курсор из элемента переставляется на каждом доставленном элементе, поэтому обрыв на середине не теряет данные.
Дедупликация
Ключ дедупликации считается по идентификатору элемента, а если пути до него нет, по хешу тела элемента. Один и тот же элемент второй раз событием не станет.
Защита от запросов во внутреннюю сеть
Адрес проверяется после разрешения имени, редиректы не следуются, внутренние и локальные адреса отклоняются. Ответ ограничен по размеру и времени.
Заголовок авторизации под шифрованием
Значение заголовка хранится зашифрованным и обратно не показывается. Для смены вводится новое.
Событие не пришло
Три причины, которые встречаются чаще остальных. Всё принятое видно в ленте принятого в кабинете вместе с типом и историей доставки.
Подключение в ошибке: адрес не разрешён
Адрес указывает на внутреннюю сеть или отвечает редиректом. Укажите публичный адрес, который отдаёт JSON напрямую.
Каждый опрос создаёт одни и те же события
Не настроен курсор или путь до идентификатора указан неверно. Проверьте оба пути на реальном ответе API.
Список пуст
Путь до списка не совпадает со структурой ответа. Если ответ сам является массивом, оставьте путь пустым.
Какой API подойдёт?
Любой, который по GET отдаёт JSON со списком элементов и позволяет запросить изменения с некоторого момента: параметром since, страницей или полем времени обновления в элементе.
Как часто идёт опрос?
По расписанию подключения: от одной минуты до суток, по умолчанию раз в пять минут.
Что если API отвечает медленно или падает?
Опрос ограничен по времени и повторяется по расписанию. Курсор остаётся на последнем доставленном элементе, поэтому ничего не теряется.
Другие интеграции
Платёжные системы, маркетплейсы и любая система с подписанными вебхуками или HTTP API.