Register a New Automation Rule bizproc.robot.add

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: bizproc

Who can execute the method: administrator

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

It works only 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

By default, the parameter is empty, which is equivalent to waiting for a response from the application. The Automation rule does not wait for a response only when explicitly set to N

NAME*
string | object

Name of the Automation rule.

It can be a string or an associative array of localized strings like:

'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 like:

'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 to limit the Automation rule by document type and edition.

It 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 limit Automation rules by Bitrix24 edition, specify:

  • b24 — for cloud
  • box — for on-premise

Examples:

  1. Exclude the Automation rule for on-premise Bitrix24 
    'FILTER': {
            EXCLUDE: [ 'box' ]
        }
  2. 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' like:

[
            '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': 'Ordnen Sie eine fortlaufende Nummer zu',
                '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 -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);
        }
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.bizproc.robot.add(
                code="test_robot",
                handler="https://example.com/robot.php",
                name="Send a message",
                auth_user_id=1,
                use_subscription=True,
                properties={
                    "datetime": {
                        "Name": "At what time",
                        "Type": "datetime",
                    },
                    "text": {
                        "Name": "Text",
                        "Type": "text",
                    },
                    "user": {
                        "Name": "To",
                        "Type": "user",
                        "Default": "Author;",
                    },
                },
                filter={
                    "INCLUDE": [
                        [
                            "crm",
                            "CCrmDocumentDeal",
                        ],
                        [
                            "crm",
                            "CCrmDocumentLead",
                        ],
                    ],
                },
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "bizproc.robot.add", b24.Params{
        	"CODE":             "test_robot",
        	"HANDLER":          "https://your_domain/robot.php",
        	"AUTH_USER_ID":     1,
        	"USE_SUBSCRIPTION": "Y",
        	"NAME":             "Send Message",
        	"PROPERTIES": b24.Params{
        		"datetime": b24.Params{
        			"Name": "When",
        			"Type": "datetime",
        		},
        		"text": b24.Params{
        			"Name": "Text",
        			"Type": "text",
        		},
        		"user": b24.Params{
        			"Name":    "To",
        			"Type":    "user",
        			"Default": "Author;",
        		},
        	},
        	"FILTER": b24.Params{
        		"INCLUDE": []any{
        			[]string{"crm", "CCrmDocumentDeal"},
        			[]string{"crm", "CCrmDocumentLead"},
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("bizproc.robot.add: %w", err)
        }
        
        var ok bool
        if err := json.Unmarshal(res.Result, &ok); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println("done:", ok)

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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 are not provided

ERROR_ACTIVITY_VALIDATION_FAILURE

Empty activity code!

Activity code is not specified

ERROR_ACTIVITY_VALIDATION_FAILURE

Wrong activity code!

Invalid activity 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!

Activity 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!

The 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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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

Previous
Overview of Methods
Next
Update Automation Rule Fields