Register a New Automation Rule bizproc.robot.add

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect the MCP server so that the assistant can utilize the official REST documentation.

Scope: bizproc

Who can execute the method: administrator

The method bizproc.robot.add registers a new Automation rule.

It only works in the context of an application.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Internal identifier of the Automation rule. It must be unique within the application. Allowed characters are `a-z`, `A-Z`, `0-9`, dot, hyphen, and underscore `_`
HANDLER* `string`	URL to which the Automation rule will send data via the Bitrix24 queue server. The link must have the same domain where the application is installed
AUTH_USER_ID `integer`	Identifier of the user whose token will be passed to the application
USE_SUBSCRIPTION `boolean`	Should the Automation rule wait for a response from the application? Possible values: `Y` — yes `N` — no
NAME* `string` \| `object`	Name of the Automation rule. It can be a string or an associative array of localized strings in the following format: `'NAME': { 'de': 'Automatisierungsregel Name', 'en': 'Automation rule name', ... },`
DESCRIPTION `string` \| `object`	Description of the Automation rule. It can be a string or an associative array of localized strings in the following format: `'DESCRIPTION': { 'de': 'Beschreibung der Automatisierungsregel', 'en': 'Automation rule description', ... },`
PROPERTIES `object`	Object with parameters of the Automation rule. Contains objects, each describing a parameter of the Automation rule. The system name of the parameter must start with a letter and can contain characters `a-z`, `A-Z`, `0-9`, and underscore `_`
RETURN_PROPERTIES `object`	Object with additional results of the Automation rule. Contains objects, each describing a parameter of the Automation rule. This parameter controls the ability of the Automation rule to wait for a response from the application and work with the data that will come in the response. The system name of the parameter must start with a letter and can contain characters `a-z`, `A-Z`, `0-9`, and underscore `_`
DOCUMENT_TYPE `array`	Document type that will determine the data types for the `PROPERTIES` and `RETURN_PROPERTIES` parameters. Consists of three string-type elements: module identifier object identifier document type Possible value options: CRM Module `['crm', 'CCrmDocumentLead', 'LEAD']` — leads `['crm', 'CCrmDocumentDeal', 'DEAL']` — deals `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Quote', 'QUOTE']` — estimates `['crm', 'Bitrix\Crm\Integration\BizProc\Document\SmartInvoice', 'SMART_INVOICE']` — invoices `['crm', 'Bitrix\Crm\Integration\BizProc\Document\Dynamic', 'DYNAMIC_XXX']` — SPAs, where XXX is the identifier of the SPA
FILTER `object`	Object with rules for restricting the Automation rule by document type and edition. May contain keys: `INCLUDE` — array of rules where the Automation rule will be displayed `EXCLUDE` — array of rules where the Automation rule will be hidden Each rule in the array can be a string or an array of document types in full or partial form. To restrict Automation rules by Bitrix24 edition, specify: `b24` — for cloud `box` — for on-premise Examples: Exclude the Automation rule for on-premise Bitrix24 `'FILTER': { EXCLUDE: [ 'box' ] }` Display the Automation rule only for deals and leads in CRM `'FILTER': { INCLUDE: [ ['crm', 'CCrmDocumentDeal'], ['crm', 'CCrmDocumentLead'] ] }`
USE_PLACEMENT `boolean`	Allows opening additional settings for the Automation rule in the application slider. Possible values: `Y` — yes `N` — no
PLACEMENT_HANDLER* `string`	URL of the placement handler on the application side. Required if `USE_PLACEMENT = 'Y'`

Object PROPERTY

Name `type`	Description
Name `string` \| `object`	Name of the parameter
Description `string` \| `object`	Description of the parameter
Type `string`	Type of the parameter. Basic values: `bool` — yes or no `date` — date `datetime` — date and time `double` — number `file` — file `int` — integer `select` — list `string` — string `text` — text `user` — user
Options `array`	Array of values for the parameter of type list `'TYPE': select'` in the format: `[ 'value1': 'title1', 'value2': 'title2', 'value3': 'title3', 'value4': 'title4' ]`
Required `boolean`	Parameter requirement. Possible values: `Y` — yes `N` — no
Multiple `boolean`	Parameter multiplicity. Possible values: `Y` — yes `N` — no
Default `any`	Default value of the parameter. For `Type = 'select'`, specify the key from `Options`

Examples of Objects

Below are examples of PROPERTY objects for different parameter types.

select

'docType': {
            'Name': {
                'de': 'Dokumenttyp',
                'en': 'Document type'
            },
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'pdf',
            'Type': 'select',
            'Options': {
                'pdf': 'PDF',
                'docx': 'DOCX'
            }
        }

bool

'saveDoc': {
            'Name': {
                'de': 'Dokument speichern',
                'en': 'Save document'
            },
            'Description': {
                'de': 'Einen fortlaufenden Nummer zuweisen',
                'en': 'Assign a sequential number'
            },
            'Type': 'bool',
            'Required': 'Y',
            'Multiple': 'N',
            'Default': 'Y'
        }

file

'attachment': {
            'Name': {
                'de': 'Datei',
                'en': 'File'
            },
            'Description': {
                'de': 'Datei zum Senden',
                'en': 'File to send'
            },
            'Type': 'file',
            'Required': 'N',
            'Multiple': 'Y'
        }

string

'Parameters': {
            'Name': {
                'de': 'Vorlagenparameter',
                'en': 'Template\'s parameters'
            },
            'Description': {
                'de': 'ParamID={=ParamValue}',
                'en': 'ParamID={=ParamValue}'
            },
            'Type': 'string',
            'Required': 'N',
            'Multiple': 'Y'
        }

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"test_robot","HANDLER":"https://your_domain/robot.php","AUTH_USER_ID":1,"USE_SUBSCRIPTION":"Y","NAME":"Send Message","PROPERTIES":{"datetime":{"Name":"When","Type":"datetime"},"text":{"Name":"Text","Type":"text"},"user":{"Name":"To","Type":"user","Default":"Author;"}},"FILTER":{"INCLUDE":[["crm","CCrmDocumentDeal"],["crm","CCrmDocumentLead"]]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/bizproc.robot.add

try
        {
            const response = await $b24.callMethod(
                'bizproc.robot.add',
                {
                    'CODE': 'test_robot',
                    'HANDLER': 'https://your_domain/robot.php',
                    'AUTH_USER_ID': 1,
                    'USE_SUBSCRIPTION': 'Y',
                    'NAME': 'Send Message',
                    'PROPERTIES': {
                        'datetime': {
                            'Name': 'When',
                            'Type': 'datetime'
                        },
                        'text': {
                            'Name': 'Text',
                            'Type': 'text'
                        },
                        'user': {
                            'Name': 'To',
                            'Type': 'user',
                            'Default': 'Author;'
                        }
                    },
                    'FILTER': {
                        INCLUDE: [
                            ['crm', 'CCrmDocumentDeal'],
                            ['crm', 'CCrmDocumentLead']
                        ]
                    }
                }
            );
            
            const result = response.getData().result;
            alert("Success: " + result);
        }
        catch( error )
        {
            alert("Error: " + error);
        }

try {
            $result = $serviceBuilder
                ->getBizProcScope()
                ->robot()
                ->add(
                    'robot_code', // string $code
                    'https://example.com/handler', // string $handlerUrl
                    1, // int $b24AuthUserId
                    ['en' => 'Robot Name'], // array $localizedRobotName
                    true, // bool $isUseSubscription
                    [], // array $properties
                    false, // bool $isUsePlacement
                    [] // array $returnProperties
                );
        
            if ($result->isSuccess()) {
                print_r($result->getCoreResponse()->getResponseData()->getResult());
            } else {
                print("Failed to add Automation rule.");
            }
        } catch (Throwable $e) {
            print("Error: " . $e->getMessage());
        }

BX24.callMethod(
            'bizproc.robot.add',
            {
                'CODE': 'test_robot',
                'HANDLER': 'https://your_domain/robot.php',
                'AUTH_USER_ID': 1,
                'USE_SUBSCRIPTION': 'Y',
                'NAME': 'Send Message',
                'PROPERTIES': {
                    'datetime': {
                        'Name': 'When',
                        'Type': 'datetime'
                    },
                    'text': {
                        'Name': 'Text',
                        'Type': 'text'
                    },
                    'user': {
                        'Name': 'To',
                        'Type': 'user',
                        'Default': 'Author;'
                    }
                },
                'FILTER': {
                    INCLUDE: [
                        ['crm', 'CCrmDocumentDeal'],
                        ['crm', 'CCrmDocumentLead']
                    ]
                }
            },
            function(result)
            {
                if(result.error())
                    alert("Error: " + result.error());
                else
                    alert("Success: " + result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'bizproc.robot.add',
            [
                'CODE' => 'test_robot',
                'HANDLER' => 'https://your_domain/robot.php',
                'AUTH_USER_ID' => 1,
                'USE_SUBSCRIPTION' => 'Y',
                'NAME' => 'Send Message',
                'PROPERTIES' => [
                    'datetime' => [
                        'Name' => 'When',
                        'Type' => 'datetime'
                    },
                    'text' => [
                        'Name' => 'Text',
                        'Type' => 'text'
                    },
                    'user' => [
                        'Name' => 'To',
                        'Type' => 'user',
                        'Default' => 'Author;'
                    ]
                },
                'FILTER' => [
                    'INCLUDE' => [
                        ['crm', 'CCrmDocumentDeal'],
                        ['crm', 'CCrmDocumentLead']
                    ]
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
            "result": true,
            "time": {
                "start": 1738148752.692647,
                "finish": 1738148752.749058,
                "duration": 0.056411027908325195,
                "processing": 0.018677949905395508,
                "date_start": "2025-01-29T14:05:52+01:00",
                "date_finish": "2025-01-29T14:05:52+01:00",
                "operating_reset_at": 1738149352,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns `true` if the Automation rule was successfully added
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
            "error": "ERROR_ACTIVITY_VALIDATION_FAILURE",
            "error_description": "Empty activity code!"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Error Message	Description
`ACCESS_DENIED`	Application context required	Application context is required
`ACCESS_DENIED`	Access denied!	Method executed by a non-administrator
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty data!	Required fields with information are not specified
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty activity code!	Automation rule code is not specified
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity code!	Invalid Automation rule code
`ERROR_UNSUPPORTED_PROTOCOL`	Unsupported handler protocol	Invalid handler protocol http, https
`ERROR_WRONG_HANDLER_URL`	Wrong handler URL	Invalid handler URL
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty activity NAME!	Automation rule name is not specified
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong properties array!	Incorrectly filled `PROPERTIES` or `RETURN_PROPERTIES` parameters
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong property key !	Invalid property identifier
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Empty property NAME !	Property name is not specified
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity FILTER!	Invalid filter
`ERROR_ACTIVITY_VALIDATION_FAILURE`	Wrong activity DOCUMENT_TYPE!	Invalid `DOCUMENT_TYPE`
`ERROR_ACTIVITY_ALREADY_INSTALLED`	Activity or Automation rule already installed!	An Automation rule with this code is already installed
`ERROR_ACTIVITY_ADD_FAILURE`	Activity or Automation rule already added!	Automation rule has already been added
`ERROR_ACTIVITY_ADD_FAILURE`	Activity save error!	Failed to save the Automation rule, system error

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Update Automation Rule Fields

Register a New Automation Rule bizproc.robot.add

Method ParametersMethod Parameters

Object PROPERTYObject PROPERTY

Examples of ObjectsExamples of Objects

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning