Кастомный запрос

Введение

Когда в процессе нужно вызвать внешний интерфейс или сторонний сервис, это можно сделать через Custom request — кастомный HTTP-запрос. Типичные сценарии использования:

  • Вызов API внешних систем (CRM, AI-сервисы и т. п.)
  • Получение удалённых данных и их обработка в последующих шагах процесса
  • Передача данных в стороннюю систему (Webhook, уведомления и т. п.)
  • Запуск автоматических процессов во внутренних или внешних сервисах

Конфигурация действия

В разделе «Настройки кнопки» → «Кастомный запрос» доступны следующие параметры:

  • HTTP method — метод HTTP-запроса, например GET, POST, PUT, DELETE.
  • URL — целевой адрес запроса. Можно указать полный URL интерфейса или динамически собрать его через переменные.
  • Headers — заголовки запроса, используются для передачи аутентификационной информации или служебных параметров, например Authorization, Content-Type и т. п.
  • Parameters — параметры строки запроса (Query Parameters), обычно применяются для GET-запросов.
  • Body — тело запроса; обычно применяется для POST, PUT и подобных запросов, может содержать JSON, данные формы и т. п.
  • Timeout config — настройка таймаута запроса, ограничивает максимальное время ожидания и предотвращает длительную блокировку процесса.
  • Response type — тип данных, ожидаемых в ответе.
  • JSON — интерфейс возвращает JSON; результат записывается в контекст процесса и доступен в последующих шагах через ctx.steps.
  • Stream — интерфейс возвращает поток данных (Stream); после успешного запроса автоматически запускается скачивание файла.
  • Access control — управление доступом, ограничивает, каким ролям разрешено запускать этот шаг, чтобы обеспечить безопасность вызова интерфейса.

Прочие параметры действия

Помимо настроек запроса, кнопка кастомного запроса поддерживает и другие распространённые параметры: