Найти в Дзене

Пример настройки входящего вебхука в Битрикс24

В Битрикс24 настроен список Заявки на ремонт, для списка настроен бизнес-процесс Выполнение заявки на ремонт. Предполагается, что со стороннего сайта вебхуком будет создаваться заявка на ремонт и по созданной заявке вебхуком будет запускаться бизнес-процесс.

В моем блоге на boosty примеры настройки вебхуков, а также примеры расширения возможностей бизнес-процессов с помощью вебхуков можно найти по тегу вебхук.

Переходим в раздел Разработчикам - Готовые сценарии - Другое - Входящий вебхук.

В окне настройки входящего вебхука в поле Метод выбираем метод REST API bizproc.workflow.start, который позволяет запустить бизнес-процесс для элемента. Автоматически при выборе метода в поле Настройка прав будут установлены права доступа Бизнес-процессы (bizproc):

Настройка входящего вебхука в Битрикс24
Настройка входящего вебхука в Битрикс24

На данном этапе можно нажать кнопку Сохранить, после чего адрес из поля URL можно использовать для выполнения любых методов работы с бизнес-процессами на портале при подстановке в этот URL названия соответствующего метода REST API. Поэтому важно следить за тем, чтобы URL вебхука оставался в секрете.

В интерфейсе настройки входящего вебхука можно настроить параметры и проверить работу вебхука на конкретных данных, прежде, чем этот вебхук будет использоваться в интеграции.

Для метода bizproc.workflow.start нужно задать параметры TEMPLATE_ID - идентификатор шаблона бизнес-процесса, DOCUMENT_ID - идентификатор элемента, для которого будет запущен бизнес-процесс в формате [модуль, объект, ID_элемента]. Для списков нужно задать значения: модуль - lists, объект - BizprocDocument. В моем примеры идентификатор шаблона бизнес-процесса равен 25, бизнес-процесс будет запускаться для элемента с ID равным 7:

ID шаблона бизнес-процесса
ID шаблона бизнес-процесса
ID элемента списка
ID элемента списка

Возвращаемся к настройке входящего вебхука и нажимаем кнопку Выполнить для проверки его работы:

Настройка параметров входящего вебхука
Настройка параметров входящего вебхука

В результате при выполнении вебхука в ответе в параметре result будет находиться идентификатор запущенного бизнес-процесса:

Результат выполнения входящего вебхука
Результат выполнения входящего вебхука

Если вебхук настроен неправильно или в параметры вебхука переданы некорректные значения, то в ответе будет находиться информация об ошибке.

Для элемента списка при этом на вкладке Бизнес-процессы будет информация о запуске бизнес-процесса:

Запущенный для элемента бизнес-процесс
Запущенный для элемента бизнес-процесс
Если статья была Вам полезна, поставьте, пожалуйста, лайк - это помогает мне в продвижении блога 👍
Больше статей в моем блоге на https://boosty.to/luba.tinaeva.b24.