Application Automation Rules: Overview of Methods

Application Automation Rules add a step to Bitrix24 automation that invokes an application handler. This step accepts input parameters, can wait for a response from an external system, and return output values to the workflow.

In the REST API, Application Automation Rules and application actions are similar in model. Each type has separate methods for registration, updating, deletion, and listing. A common execution mechanism is used within the platform.

Automation Rules can be utilized in CRM automation, workflows, and Smart scripts. Therefore, for new development, it is recommended to choose Automation Rules, while application actions should primarily be used to support existing integrations.

Quick navigation: all methods

User documentation:

• Automation rules in CRM
• Smart scripts in CRM

What Tasks Do Application Automation Rules SolveWhat Tasks Do Application Automation Rules Solve

• Perform external actions in CRM automation and workflows.
• Return computed data to the process for subsequent steps.
• Restrict availability based on document type and Bitrix24 edition.
• Log messages during the execution of the script.

How Result Waiting WorksHow Result Waiting Works

If the Automation Rule needs to wait for a response from an external system, specify RETURN_PROPERTIES and USE_SUBSCRIPTION = 'Y' when registering or updating via bizproc.robot.add and bizproc.robot.update.

The script then operates as follows:

1. The Automation Rule is triggered in the automation and sends data to the application handler HANDLER.
2. The application receives a unique key EVENT_TOKEN and calculates the result.
3. The application returns values to the process using the method bizproc.event.send.
4. If necessary, the application adds a note to the process log via LOG_MESSAGE.

How to Get StartedHow to Get Started

1. Register the Automation Rule using the method bizproc.robot.add.
2. Place the Automation Rule in the desired CRM automation or workflow and start the script.
3. Update the Automation Rule settings using the method bizproc.robot.update.
4. Check the list of registered Automation Rules via bizproc.robot.list.
5. Remove outdated Automation Rules using the method bizproc.robot.delete.

Important ConsiderationsImportant Considerations

• The methods for managing Automation Rules bizproc.robot.add, bizproc.robot.update, bizproc.robot.list, bizproc.robot.delete only work in the context of the installed application.
• For bizproc.event.send, a valid EVENT_TOKEN is required; otherwise, the method will return an access error.

Relationships with Other ObjectsRelationships with Other Objects

• CRM Objects. Through DOCUMENT_TYPE and FILTER, the Automation Rule connects with leads, deals, and other document types where it should be available.
• Application Actions. Automation Rules and actions use a common internal mechanism, so it is important to choose a primary path for new scenarios when designing the integration.

Overview of MethodsOverview of Methods

Scope: bizproc

Who can execute the method: depends on the method

Method	Description
bizproc.robot.add	Registers a new Automation Rule
bizproc.robot.update	Updates the fields of the Automation Rule
bizproc.robot.list	Retrieves a list of Automation Rules registered by the application
bizproc.robot.delete	Deletes a registered Automation Rule
bizproc.event.send	Sends the output values of the Automation Rule or action to the process