#Bizproc robots

Entity: bizprocRobot | Scope: bizproc | Base path: /v1/bizproc-robots

Регистрация роботов для автоматизации Битрикс24. Роботы появляются и в конфигураторе роботов, и в дизайнере бизнес-процессов. Рекомендуемый Битрикс24 формат вместо activities. Требует OAuth-приложение. Только администраторы.

#Operations

Method	Path	Description	Bitrix24 Method
`GET`	`/v1/bizproc-robots`	Список зарегистрированных роботов	`bizproc.robot.list`
`POST`	`/v1/bizproc-robots`	Зарегистрировать робота	`bizproc.robot.add`
`PATCH`	`/v1/bizproc-robots/:code`	Обновить робота	`bizproc.robot.update`
`DELETE`	`/v1/bizproc-robots/:code`	Удалить робота	`bizproc.robot.delete`

Disabled operations: get (нет метода в Битрикс24)

Важно: Идентификатор — CODE (строка), не числовой ID. list возвращает массив строк (кодов).

#Fields

API Name	Bitrix24 Name	Type	Description
`code`	`CODE`	string	Уникальный код робота (a-z, A-Z, 0-9, ., -, _)
`handler`	`HANDLER`	string	URL обработчика (тот же домен, что и приложение)
`name`	`NAME`	string	Название (строка или локализованный объект `{ru: '...', en: '...'}`)
`description`	`DESCRIPTION`	string	Описание (строка или локализованный объект)
`authUserId`	`AUTH_USER_ID`	number	ID пользователя, чей токен передаётся приложению
`useSubscription`	`USE_SUBSCRIPTION`	string	Ожидать ответ от приложения (`Y`/`N`)
`properties`	`PROPERTIES`	object	Входные параметры робота
`returnProperties`	`RETURN_PROPERTIES`	object	Выходные параметры робота
`documentType`	`DOCUMENT_TYPE`	object	Тип документа `[module, object, documentType]`
`filter`	`FILTER`	object	Правила INCLUDE/EXCLUDE для типа документа
`usePlacement`	`USE_PLACEMENT`	string	Открывать настройки в слайдере (`Y`/`N`)
`placementHandler`	`PLACEMENT_HANDLER`	string	URL слайдера (обязателен при `usePlacement: 'Y'`)

#Document types

Entity	documentType
Leads	`['crm', 'CCrmDocumentLead', 'LEAD']`
Deals	`['crm', 'CCrmDocumentDeal', 'DEAL']`
Quotes	`['crm', 'Bitrix\\Crm\\Integration\\BizProc\\Document\\Quote', 'QUOTE']`
Invoices	`['crm', 'Bitrix\\Crm\\Integration\\BizProc\\Document\\SmartInvoice', 'SMART_INVOICE']`
Smart Processes	`['crm', 'Bitrix\\Crm\\Integration\\BizProc\\Document\\Dynamic', 'DYNAMIC_XXX']`

#Examples

#List

Terminal

curl -X GET 'https://vibecode.bitrix24.tech/v1/bizproc-robots' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Response: { "success": true, "data": ["my_robot_1", "sms_robot"] }

#Create

Terminal

curl -X POST 'https://vibecode.bitrix24.tech/v1/bizproc-robots' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "send_notification",
    "handler": "https://myapp.example.com/robot-handler",
    "name": {"ru": "Отправить уведомление", "en": "Send Notification"},
    "useSubscription": "Y",
    "documentType": ["crm", "CCrmDocumentDeal", "DEAL"],
    "properties": {
      "message": {
        "Name": {"ru": "Текст уведомления"},
        "Type": "string",
        "Required": "Y"
      }
    },
    "returnProperties": {
      "sent": {
        "Name": {"ru": "Отправлено"},
        "Type": "bool"
      }
    }
  }'

#Update

Terminal

curl -X PATCH 'https://vibecode.bitrix24.tech/v1/bizproc-robots/send_notification' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"handler": "https://myapp.example.com/new-robot-handler"}'

#Delete

Terminal

curl -X DELETE 'https://vibecode.bitrix24.tech/v1/bizproc-robots/send_notification' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Authorization: Bearer YOUR_TOKEN'

#Authorization

bizproc.robot.add requires application context. Personal keys (webhooks) will fail with "Unable to get application by token". Use OAuth app keys with bizproc scope and Authorization: Bearer header.

#Errors

Code	Description
`ERROR_ACTIVITY_ALREADY_INSTALLED`	Robot with this CODE already registered
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Missing required fields or invalid values
`ERROR_ACTIVITY_NOT_FOUND`	Robot with this CODE not found
`ERROR_UNSUPPORTED_PROTOCOL`	Handler URL protocol not supported
`ACCESS_DENIED`	User is not administrator