Вебхуки — инструмент для получения данных от сторонних сервисов. Как администратор BPMSoft, вы можете настроить автоматическое реагирование на запросы для мгновенного запуска бизнес-процессов и действий над объектами.
Конфигурация пользовательских вебхуков в BPMSoft осуществляется с помощью инструментов low-code, что значительно упрощает настройку и использование.
Настройка вебхуков выполняется в разделе «Вебхуки», в который можно перейти несколькими способами:
Общая процедура настройки вебхука включает следующие шаги:
Для создания нового вебхука выполните следующие действия:
Таблица 1 — Свойства вебхука
Рисунок 1 — Свойства вебхука
Для выполнения методов вебхука существует три способа аутентификации:
Включение анонимной аутентификации уменьшает безопасность BPMSoft. Это связано с тем, что неавторизованные пользователи могут выполнять запросы на добавление, изменение. Не рекомендуем использовать данный режим при реализации интеграций.
BPMSoft поддерживает способ анонимной аутентификации, когда для доступа к методам вебхуков не требуется никаких пользовательских данных. Анонимные вебхуки не требуют авторизации для доступа к методам.
По умолчанию анонимная аутентификация отключена.
Для включения анонимной аутентификации необходимо выполнить следующие действия:
В результате выполнения данных настроек методы вебхука станут доступны для вызова без аутентификации.
Включение анонимной аутентификации доступно только при развертывании on-site.
Для того чтобы методы вебхука были доступны для вызова через forms-аутентификацию, выполните следующие действия:
Примечание. При выполнении операций над объектами система проверяет права пользователя на эти действия.
После сохранения методы вебхука станут доступны для вызова при передаче специального cookie в заголовках последующих запросов. Подробнее: Forms-аутентификация.
Для того чтобы методы вебхука были доступны для вызова с помощью передачи JWT-токенов, выполните следующие шаги:
Примечание. Правила создания секретного ключа для генерации JWT-токена:
Рисунок 2 — Тип аутентификации «JWT»
После сохранения вебхука кнопка «Сгенерировать токен» станет активной. Для генерации токена:
Рисунок 3 — Модальное окно генерации JWT-токена
Скопируйте значение токена, так как после закрытия этого окна повторно посмотреть его будет невозможно.
При необходимости можно вернуться в вебхук и создать новый токен, нажав на кнопку «Перегенерировать».
После сохранения методы вебхука станут доступны для вызова при передаче JWT-токена в заголовках последующих запросов.
Для создания метода вебхука выполните следующие шаги:
Таблица 2 — Свойства метода вебхука
Рисунок 4 — Пример заполнения метода вебхука
Рисунок 5 — Деталь «Методы вебхука»
После публикации метод станет доступен для вызова из внешней системы.
В метод вебхука можно добавить следующие виды параметров:
Параметры запроса принимаются на вход вебхуком при его вызове из внешней системы.
Для добавления параметра запроса выполните следующие шаги:
Таблица 3 — Свойства параметра запроса
Рисунок 6 — Пример заполнения параметра запроса
Примечание. В BPMSoft существует возможность автоматического создания параметров запроса. Подробнее: Быстрая настройка.
Параметры ответа возвращаются вебхуком после успешного выполнения запроса из внешней системы.
Для добавления параметра ответа выполните следующие шаги:
Таблица 4 — Свойства параметра ответа
Для автоматического добавления параметров запроса или ответа выполните следующие шаги:
Например:
{ "name": "testName", "age": 18 }
После выполнения быстрой настройки в выбранной вкладке будут добавлены параметры. По вышеприведенному примеру добавится два параметра:
Таблица 5 — Параметры, добавленные быстрой настройкой
Для добавления действий, которые будут выполнены при вызове вебхука, выполните следующие шаги:
Таблица 6 — Свойства действия при получении вебхука
Рисунок 7 — Действие при получении вебхука
Возможности интеграции Выполнить запрос в Postman с авторизацией вручную