#Bizproc activities

Entity: bizprocActivity | Scope: bizproc | Base path: /v1/bizproc-activities

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

#Operations

Method Path Description Bitrix24 Method
GET /v1/bizproc-activities Список зарегистрированных действий bizproc.activity.list
POST /v1/bizproc-activities Зарегистрировать действие bizproc.activity.add
PATCH /v1/bizproc-activities/:code Обновить действие bizproc.activity.update
DELETE /v1/bizproc-activities/:code Удалить действие bizproc.activity.delete
POST /v1/workflows/activity-log Записать в журнал БП bizproc.activity.log

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')

#Examples

#List

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

Response: { "success": true, "data": ["my_action_1", "my_action_2"] }

#Create

Terminal 
curl -X POST 'https://vibecode.bitrix24.tech/v1/bizproc-activities' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "my_custom_action",
    "handler": "https://myapp.example.com/handler",
    "name": {"ru": "Мое действие", "en": "My Action"},
    "useSubscription": "Y",
    "properties": {
      "message": {
        "Name": {"ru": "Сообщение"},
        "Type": "string",
        "Required": "Y"
      }
    },
    "returnProperties": {
      "result": {
        "Name": {"ru": "Результат"},
        "Type": "string"
      }
    }
  }'

#Update

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

#Delete

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

#Activity Log

Terminal 
curl -X POST 'https://vibecode.bitrix24.tech/v1/workflows/activity-log' \
  -H 'X-Api-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"eventToken": "TOKEN_FROM_HANDLER", "logMessage": "Processing complete"}'

#Authorization

bizproc.activity.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 Action with this CODE already registered
ERROR_ACTIVITY_VALIDATION_FAILURE Missing required fields or invalid values
ERROR_ACTIVITY_NOT_FOUND Action with this CODE not found
ERROR_UNSUPPORTED_PROTOCOL Handler URL protocol not supported
ACCESS_DENIED User is not administrator