Операция Webhook позволяет автоматически передавать информацию об экземпляре процесса из QuickBPM во внешнюю систему.
Например, компания занимается продажей и поставкой оборудования. После того как сотрудник отдела продаж оформит заявку от клиента, она отправляется на склад, где заказ формируется для отправки. После выставления счета клиенту и отправки заказа Webhook автоматически отправляет данные о заказе в программу складского учета.
Это значительно сокращает время на ввод данных и позволяет избежать ошибок, например, при указании артикула товара.
начало внимание
Настраивать блок Webhook могут только пользователи, включенные в группу Администраторы.
конец внимание
Как настроить блок Webhook на схеме процесса
На странице процесса нажмите +Добавить шаг и выберите тип Webhook. Размещайте его там, где при исполнении процесса потребуется передать данные во внешнюю систему.
Чтобы открыть окно с настройками, наведите курсор на номер задачи и нажмите на появившийся значок . Настройки выполняются на вкладках Основное и Обработка ошибок.
Вкладка «Основное»
На этой вкладке формируется http-запрос. Заполните следующие поля:
- URL — укажите URL запроса для обращения к методу API внешней системы, например, http://example.com/api/create-order/. Вы можете использовать также контекстные переменные процесса и функцию DateTime. Чтобы добавить переменную, нажмите на знак {+} в правой части поля. Для использования функции DateTime нажмите на символ f(x). Подробнее про функцию DateTime вы можете прочитать в статье Название элемента.
- Метод — выберите метод GET или POST. При выборе метода POST появится дополнительное поле Тип запроса.
- Тип запроса — для метода POST доступны типы JSON, FORM и TEXT.
- Данные — настройте связь полей процесса и полей вашего запроса. Нажмите кнопку + Параметр и в колонке Поля процесса выберите контекстную переменную, например, Серийный номер. Поле Параметры запроса будет заполнено автоматически.
Если ранее в поле Тип запроса вы выбрали TEXT, то в разделе Данные вам потребуется указать текстовый шаблон, который будет передаваться в запросе. Для создания шаблона вы можете использовать любой текст, а также контекстные переменные процесса и функцию DateTime.
Чтобы добавить переменную, нажмите на знак {+} в правой части поля. Для использования функции DateTime нажмите на символ f(x). Про использование функции DateTime в шаблонах можно подробно прочитать в статье Название элемента.
Вкладка «Обработка ошибок»
На данной вкладке вы можете настроить поведение QuickBPM в том случае, если внешняя система вернет ошибку при отправке запроса.
Если вы хотите, чтобы при ошибке система повторно отправила запрос, поставьте галочку Повторить выполнение. Выберите количество повторений и укажите, сколько секунд должно пройти между ними.
Если вы хотите, чтобы при ошибке система присылала соответствующее оповещение, поставьте галочку Оповещение. Появится кнопка Добавить. Нажмите на нее, чтобы выбрать пользователей, которым будут приходить оповещения.
После того как вы указали все настройки, нажмите Сохранить.