Вебхуки
Вебхуки — это подписки на события в Бипиуме, при срабатывании которых система автоматически отправляет HTTP-запрос во внешнюю систему. Используются для интеграции: уведомить CRM, обновить данные в стороннем сервисе, запустить процесс во внешней системе.
Как это работает
Когда сотрудник создает, изменяет или удаляет запись — Бипиум проверяет подписки и отправляет POST-запрос с данными об изменении на указанный URL. Внешняя система получает запрос и обрабатывает его по своей логике.
Настройка подписки
Подписки хранятся в каталоге «Управление → Вебхуки». Каждая запись — одна подписка со следующими параметрами:
Поле | Описание |
Каталог | Каталог, за изменениями в котором следит подписка. |
События | Типы событий, которые будут пересылаться во внешнюю систему. Одна подписка может отслеживать несколько событий. |
Отслеживать поля | Список ID полей, изменение которых будет запускать отправку. Если оставить пустым — подписка срабатывает при изменении любого поля. |
URL | Адрес внешней системы, на который Бипиум отправит запрос. Протокол обязателен: https://... |
Инициатор | Кого будет отслеживать подписка в качестве инициатора. |
Секретная строка | Ключ для подписи сообщений. Внешняя система может проверить подпись и убедиться что запрос пришёл от Бипиума. |
Номер последнего события | Cчетчик сработанных событий (служебное поле). |
Типы событий
Тип | Код | Когда срабатывает |
Уведомление о создании | record.created | После создания записи |
Уведомление об изменении | record.updated | После изменения записи |
Уведомление об удалении | record.deleted | После удаления записи |
Запрос на создание | record.before.created | До создания — ожидает одобрения от внешней системы |
Запрос на изменение | record.before.updated | До изменения — ожидает одобрения от внешней системы |
Запрос на удаление | record.before.deleted | До удаления — ожидает одобрения от внешней системы |
Изменено поле во время редактирования | record.updating | После изменения поля в карточке, до сохранения записи |
Использование вебхуков
Принцип работы и формат сообщений описан в разделе по интеграции в статье «Вебхуки».