Bitrix24 Business Processes API
The Business Processes API from Bitrix24 — 21 operation(s) for business processes.
OpenAPI Specification
openapi: 3.0.3
info:
title: Bitrix24 REST BIconnector Business Processes API
version: 1.0.0
description: 'Bitrix24 REST API provides access to CRM, tasks, drive, chats, telephony, e-commerce, automation, and other modules. Documentation: https://apidocs.bitrix24.com'
contact:
name: Bitrix24 Developer Support
url: https://apidocs.bitrix24.com/support.html
license:
name: MIT
url: https://github.com/bitrix-tools/b24-rest-docs/blob/main/LICENSE
x-logo:
url: https://apidocs.bitrix24.com/_images/bitrix24logo.svg
servers:
- url: https://{portal}.bitrix24.com/rest
description: Your Bitrix24 portal (cloud)
variables:
portal:
default: your-portal
description: Subdomain of your Bitrix24 portal
- url: https://{host}/rest
description: On-Premise Bitrix24 installation
variables:
host:
default: your-bitrix24.example.com
description: Host of your on-premise installation
security:
- AccessToken: []
tags:
- name: Business Processes
paths:
/bizproc.activity.add:
post:
summary: Add a New Action bizproc.activity.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method adds a new action for use in workflows. The method works only in the context of an [application](../../../settings/app-installation/index.md). Each document generates its own set of field types. For example, in CRM, there is a field of type Address `UF:address`. To use this field type in your actions, specify the CRM document type in `DOCUMENT_TYPE` and describe the field properties in `PROPERTIES`.
operationId: bizproc_activity_add
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CODE:
type: string
description: '| Internal identifier of the action. It must be unique within the application.'
HANDLER:
type: string
description: '| URL to which the action will send data via the Bitrix24 queue server.'
AUTH_USER_ID:
type: integer
description: '| Identifier of the user whose token will be passed to the application ||'
USE_SUBSCRIPTION:
type: boolean
description: '| Should the action wait for a response from the application. Possible values:'
PROPERTIES:
type: object
description: '| Object with action parameters. Contains objects, each describing a parameter of the action.'
RETURN_PROPERTIES:
type: object
description: '| Object with additional results of the action. Contains objects, each describing a parameter of the action.'
DOCUMENT_TYPE:
type: array
items: {}
description: '| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:'
FILTER:
type: object
description: '| Object with rules to restrict the action by document type and edition.'
USE_PLACEMENT:
type: boolean
description: '| Allows opening additional settings for the action in the application slider. Possible values:'
PLACEMENT_HANDLER:
type: string
description: '| URL of the placement handler on the application side. Required if `USE_PLACEMENT = ''Y''` ||'
Type:
type: string
description: '| Type of the parameter. Basic values:'
Options:
type: array
items: {}
description: '| Array of values for the parameter of type list `''TYPE'': select''` like:'
Required:
type: boolean
description: '| Requirement of the parameter. Possible values:'
Multiple:
type: boolean
description: '| Multiplicity of the parameter. Possible values:'
Default:
type: string
description: '| Default value of the parameter ||'
required:
- CODE
- HANDLER
- PLACEMENT_HANDLER
application/x-www-form-urlencoded:
schema:
type: object
properties:
CODE:
type: string
description: '| Internal identifier of the action. It must be unique within the application.'
HANDLER:
type: string
description: '| URL to which the action will send data via the Bitrix24 queue server.'
AUTH_USER_ID:
type: integer
description: '| Identifier of the user whose token will be passed to the application ||'
USE_SUBSCRIPTION:
type: boolean
description: '| Should the action wait for a response from the application. Possible values:'
PROPERTIES:
type: object
description: '| Object with action parameters. Contains objects, each describing a parameter of the action.'
RETURN_PROPERTIES:
type: object
description: '| Object with additional results of the action. Contains objects, each describing a parameter of the action.'
DOCUMENT_TYPE:
type: array
items: {}
description: '| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:'
FILTER:
type: object
description: '| Object with rules to restrict the action by document type and edition.'
USE_PLACEMENT:
type: boolean
description: '| Allows opening additional settings for the action in the application slider. Possible values:'
PLACEMENT_HANDLER:
type: string
description: '| URL of the placement handler on the application side. Required if `USE_PLACEMENT = ''Y''` ||'
Type:
type: string
description: '| Type of the parameter. Basic values:'
Options:
type: array
items: {}
description: '| Array of values for the parameter of type list `''TYPE'': select''` like:'
Required:
type: boolean
description: '| Requirement of the parameter. Possible values:'
Multiple:
type: boolean
description: '| Multiplicity of the parameter. Possible values:'
Default:
type: string
description: '| Default value of the parameter ||'
required:
- CODE
- HANDLER
- PLACEMENT_HANDLER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.activity.delete:
post:
summary: Delete Action bizproc.activity.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method deletes an action for workflows that was added by the application. It only works in the context of the [application](../../../settings/app-installation/index.md). When the application is deleted or updated, the associated actions are removed from the list of actions in the workflow designer. If the action is used in a workflow, it is blocked and can only be removed from the scheme. Upon reinstalling the application, the action becomes available again.
operationId: bizproc_activity_delete
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CODE:
type: string
description: '| Symbolic identifier of the application action ||'
required:
- CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
CODE:
type: string
description: '| Symbolic identifier of the application action ||'
required:
- CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.activity.list:
post:
summary: Get a List of Application Actions bizproc.activity.list
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so the assistant can utilize the official REST documentation. This method retrieves a list of actions set by the application. It only works in the context of the [application](../../../settings/app-installation/index.md).
operationId: bizproc_activity_list
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-list.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
application/x-www-form-urlencoded:
schema:
type: object
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.activity.log:
post:
summary: Write Information to the Business Process Log bizproc.activity.log
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method logs information into the business process log. Event logging must be enabled in the business process template.
operationId: bizproc_activity_log
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-log.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
EVENT_TOKEN:
type: string
description: '| A unique key required to send an event to the business process.'
LOG_MESSAGE:
type: string
description: '| Message to be logged ||'
required:
- EVENT_TOKEN
- LOG_MESSAGE
application/x-www-form-urlencoded:
schema:
type: object
properties:
EVENT_TOKEN:
type: string
description: '| A unique key required to send an event to the business process.'
LOG_MESSAGE:
type: string
description: '| Message to be logged ||'
required:
- EVENT_TOKEN
- LOG_MESSAGE
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.activity.update:
post:
summary: Update Action bizproc.activity.update
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method updates a business process action added by the application. It works only in the context of the [application](../../../settings/app-installation/index.md).
operationId: bizproc_activity_update
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-activity/bizproc-activity-update.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CODE:
type: string
description: '| Internal identifier of the action ||'
FIELDS:
type: object
description: '| Object with fields of the business process action ||'
HANDLER:
type: string
description: '| URL to which the action will send data via the Bitrix24 queue server.'
AUTH_USER_ID:
type: integer
description: '| Identifier of the user whose token will be passed to the application ||'
USE_SUBSCRIPTION:
type: boolean
description: '| Should the action wait for a response from the application. Possible values:'
PROPERTIES:
type: object
description: '| Object with parameters of the action. Contains objects, each describing a parameter of the action.'
RETURN_PROPERTIES:
type: object
description: '| Object with additional results of the action. Contains objects, each describing a parameter of the action.'
DOCUMENT_TYPE:
type: array
items: {}
description: '| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:'
FILTER:
type: object
description: '| Object with rules for limiting the action by document type and edition.'
USE_PLACEMENT:
type: boolean
description: '| Allows opening additional settings for the action in the application slider. Possible values:'
PLACEMENT_HANDLER:
type: string
description: '| URL of the placement handler on the application side. Required if `USE_PLACEMENT = ''Y''` ||'
Type:
type: string
description: '| Type of the parameter. Basic values:'
Options:
type: array
items: {}
description: '| Array of values for the parameter of type list `''TYPE'': select''` like:'
Required:
type: boolean
description: '| Parameter requirement. Possible values:'
Multiple:
type: boolean
description: '| Parameter multiplicity. Possible values:'
Default:
type: string
description: '| Default value of the parameter ||'
required:
- CODE
- FIELDS
- HANDLER
- PLACEMENT_HANDLER
application/x-www-form-urlencoded:
schema:
type: object
properties:
CODE:
type: string
description: '| Internal identifier of the action ||'
FIELDS:
type: object
description: '| Object with fields of the business process action ||'
HANDLER:
type: string
description: '| URL to which the action will send data via the Bitrix24 queue server.'
AUTH_USER_ID:
type: integer
description: '| Identifier of the user whose token will be passed to the application ||'
USE_SUBSCRIPTION:
type: boolean
description: '| Should the action wait for a response from the application. Possible values:'
PROPERTIES:
type: object
description: '| Object with parameters of the action. Contains objects, each describing a parameter of the action.'
RETURN_PROPERTIES:
type: object
description: '| Object with additional results of the action. Contains objects, each describing a parameter of the action.'
DOCUMENT_TYPE:
type: array
items: {}
description: '| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:'
FILTER:
type: object
description: '| Object with rules for limiting the action by document type and edition.'
USE_PLACEMENT:
type: boolean
description: '| Allows opening additional settings for the action in the application slider. Possible values:'
PLACEMENT_HANDLER:
type: string
description: '| URL of the placement handler on the application side. Required if `USE_PLACEMENT = ''Y''` ||'
Type:
type: string
description: '| Type of the parameter. Basic values:'
Options:
type: array
items: {}
description: '| Array of values for the parameter of type list `''TYPE'': select''` like:'
Required:
type: boolean
description: '| Parameter requirement. Possible values:'
Multiple:
type: boolean
description: '| Parameter multiplicity. Possible values:'
Default:
type: string
description: '| Default value of the parameter ||'
required:
- CODE
- FIELDS
- HANDLER
- PLACEMENT_HANDLER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.event.send:
post:
summary: Return Parameters to Action or Automation Rule bizproc.event.send
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method returns the output parameters to the Automation rule or action that were specified during the registration or update of the Automation rule or action.
operationId: bizproc_event_send
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-event-send.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
EVENT_TOKEN:
type: string
description: '| A special token that is sent to the application handler when the action or Automation rule is executed. The value of this token is received by the handler in the input data array.'
RETURN_VALUES:
type: object
description: '| An array of returned values from the action or Automation rule. It specifies the values of properties that were registered as additional results `RETURN_PROPERTIES` by the methods:'
LOG_MESSAGE:
type: string
description: '| Text for the business process log.'
application/x-www-form-urlencoded:
schema:
type: object
properties:
EVENT_TOKEN:
type: string
description: '| A special token that is sent to the application handler when the action or Automation rule is executed. The value of this token is received by the handler in the input data array.'
RETURN_VALUES:
type: object
description: '| An array of returned values from the action or Automation rule. It specifies the values of properties that were registered as additional results `RETURN_PROPERTIES` by the methods:'
LOG_MESSAGE:
type: string
description: '| Text for the business process log.'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.robot.add:
post:
summary: Register a New Automation Rule bizproc.robot.add
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. The method `bizproc.robot.add` registers a new Automation rule. It only works in the context of an [application](../../../settings/app-installation/index.md).
operationId: bizproc_robot_add
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-robot-add.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CODE:
type: string
description: '| Internal identifier of the Automation rule. It must be unique within the application.'
HANDLER:
type: string
description: '| URL to which the Automation rule will send data via the Bitrix24 queue server.'
AUTH_USER_ID:
type: integer
description: '| Identifier of the user whose token will be passed to the application ||'
USE_SUBSCRIPTION:
type: boolean
description: '| Should the Automation rule wait for a response from the application? Possible values:'
PROPERTIES:
type: object
description: '| Object with parameters of the Automation rule. Contains objects, each describing a parameter of the Automation rule.'
RETURN_PROPERTIES:
type: object
description: '| Object with additional results of the Automation rule. Contains objects, each describing a parameter of the Automation rule.'
DOCUMENT_TYPE:
type: array
items: {}
description: '| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:'
FILTER:
type: object
description: '| Object with rules for restricting the Automation rule by document type and edition.'
USE_PLACEMENT:
type: boolean
description: '| Allows opening additional settings for the Automation rule in the application slider. Possible values:'
PLACEMENT_HANDLER:
type: string
description: '| URL of the placement handler on the application side. Required if `USE_PLACEMENT = ''Y''` ||'
Type:
type: string
description: '| Type of the parameter. Basic values:'
Options:
type: array
items: {}
description: '| Array of values for the parameter of type list `''TYPE'': select''` in the format:'
Required:
type: boolean
description: '| Parameter requirement. Possible values:'
Multiple:
type: boolean
description: '| Parameter multiplicity. Possible values:'
Default:
type: string
description: '| Default value of the parameter. For `Type = ''select''`, specify the key from `Options` ||'
required:
- CODE
- HANDLER
- PLACEMENT_HANDLER
application/x-www-form-urlencoded:
schema:
type: object
properties:
CODE:
type: string
description: '| Internal identifier of the Automation rule. It must be unique within the application.'
HANDLER:
type: string
description: '| URL to which the Automation rule will send data via the Bitrix24 queue server.'
AUTH_USER_ID:
type: integer
description: '| Identifier of the user whose token will be passed to the application ||'
USE_SUBSCRIPTION:
type: boolean
description: '| Should the Automation rule wait for a response from the application? Possible values:'
PROPERTIES:
type: object
description: '| Object with parameters of the Automation rule. Contains objects, each describing a parameter of the Automation rule.'
RETURN_PROPERTIES:
type: object
description: '| Object with additional results of the Automation rule. Contains objects, each describing a parameter of the Automation rule.'
DOCUMENT_TYPE:
type: array
items: {}
description: '| Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements:'
FILTER:
type: object
description: '| Object with rules for restricting the Automation rule by document type and edition.'
USE_PLACEMENT:
type: boolean
description: '| Allows opening additional settings for the Automation rule in the application slider. Possible values:'
PLACEMENT_HANDLER:
type: string
description: '| URL of the placement handler on the application side. Required if `USE_PLACEMENT = ''Y''` ||'
Type:
type: string
description: '| Type of the parameter. Basic values:'
Options:
type: array
items: {}
description: '| Array of values for the parameter of type list `''TYPE'': select''` in the format:'
Required:
type: boolean
description: '| Parameter requirement. Possible values:'
Multiple:
type: boolean
description: '| Parameter multiplicity. Possible values:'
Default:
type: string
description: '| Default value of the parameter. For `Type = ''select''`, specify the key from `Options` ||'
required:
- CODE
- HANDLER
- PLACEMENT_HANDLER
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixResponse'
4XX:
description: Request error (400, 401, 403)
content:
application/json:
schema:
$ref: '#/components/schemas/BitrixError'
security:
- AccessToken: []
- OAuth2:
- bizproc
/bizproc.robot.delete:
post:
summary: Delete Registered Robot bizproc.robot.delete
description: If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the [MCP server](../../../ai-tools/mcp.md) so that the assistant can utilize the official REST documentation. This method removes a robot registered by the application. It only works in the context of the [application](../../../settings/app-installation/index.md). When the application is deleted or updated, the associated robots are removed from the list of robots. If the robot is in use, it is blocked and can only be removed from the workflow. Upon reinstalling the application, the robot becomes available again.
operationId: bizproc_robot_delete
tags:
- Business Processes
externalDocs:
url: https://apidocs.bitrix24.com/api-reference/bizproc/bizproc-robot/bizproc-robot-delete.html
description: Official Documentation
requestBody:
content:
application/json:
schema:
type: object
properties:
CODE:
type: string
description: '| Symbolic identifier of the application robot ||'
required:
- CODE
application/x-www-form-urlencoded:
schema:
type: object
properties:
CODE:
type: string
description: '| Symbolic identifier of the application robot ||'
required:
- CODE
responses:
'200':
description: Successful response
content:
application/json:
schema:
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitrix24/refs/heads/main/openapi/bitrix24-business-processes-api-openapi.yml