API - Бизнес-процессы

COMMUNITYCOREBUSINESSENTERPRISE

API бизнес-процессов принимает Webhook-запросы для запуска БП.

URL для отправки запроса содержит токен, сгенерированный в БП.

API-точка принимает запросы любых типов (но по сути воспринимает их как POST).

внимание

Для выполнения запроса к API дополнительная авторизация не требуется — доступ определяется токеном в URL

Обработка Webhook

GET | POST | PUT | PATCH | DELETE | HEAD | OPTIONS /api/public/pl/v1/webhooks/bp/{guid}

Параметры запроса

Название поля	Обязательно	Тип поля	По умолчанию	Описание
guid	+	string	нет	Идентификатор токена — это 36-символьный UUID, состоящий из шестнадцатеричных символов и дефисов

Пример входной модели

{
  "Headers": {
    "Accept": "*/*",
    "Host": "s.monq.ru",
    "User-Agent": "PostmanRuntime/7.47.1",
    "Accept-Encoding": "gzip, deflate, br",
    "Content-Type": "application/json",
    "X-Real-IP": "192.168.216.78",
    "X-Forwarded-For": "192.168.216.78",
    "X-Forwarded-Port": "443",
    "X-Forwarded-Scheme": "https",
    "timestampSortDir": "asc",
    "includeAggregations": "false",
    "Postman-Token": "4189fdb1-00f8-4e8f-8e75-e26a5127777a"
  },
  "QueryParams": {
    "source": "external-system"
  },
  "RequestMethod": "POST",
  "Body": {
    "Id": 123,
    "Message": "Любое сообщение"
  },
  "Timestamp": "2025-09-25T06:27:32.7177476+00:00",
  "WebhookTokenName": "Telegram"
}

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

Поля модели запроса

Название поля	Тип поля	Описание
Headers	dynamic	Заголовки запроса
QueryParams	dynamic	Параметры строки запроса
RequestMethod	string	Исходный HTTP-метод запроса
Body	dynamic	Тело запроса с динамической структурой - x-www-form-urlencoded - text / json (raw) - form-data
Timestamp	object	Время получения запроса в формате ISO 8601
WebhookTokenName	string	Название токена, которым выполнен запуск

Коды ответа

Код ответа	Описание
200	Запрос исполнен успешно