Workflows and Automation Rules: Overview of Methods

Workflows automate operations with documents, CRM objects, files, and list items. The bizproc.* methods start processes from templates, manage active instances, process user tasks, and add custom application actions or automation rules to automation.

A process can start automatically when an event occurs in Bitrix24 or manually at the user's initiative. Through the REST API, it is started using the bizproc.workflow.start method.

For new development, application automation rules are usually preferred. Automation rules are available in CRM automation, workflows, and smart scripts, while application actions are useful for supporting existing integrations in the workflow designer.

Quick navigation: all methods

User documentation:

• Workflows: New Interface and Features
• Automation Rules in CRM

How to Choose a SectionHow to Choose a Section

If You Need To	Open the Section
Start a process, retrieve a list of active processes, or stop execution	Main Workflow Methods
Add, update, retrieve, or delete a workflow template	Workflow Templates
Retrieve, complete, or delegate a user task	Workflow Tasks
Add an external step for CRM automation, workflows, or smart scripts	Application Automation Rules
Support an external step that is already used in the workflow designer	Application Actions

How to StartHow to Start

1. Prepare a workflow template in the Bitrix24 interface or add it using bizproc.workflow.template.add
2. Define the document for which the process will run. To start a process, you need DOCUMENT_ID, for example ['crm', 'CCrmDocumentLead', 'LEAD_1']
3. Start the process using bizproc.workflow.start, and pass TEMPLATE_ID, DOCUMENT_ID, and the template input parameters
4. Monitor active processes using bizproc.workflow.instances
5. Process user tasks using the bizproc.task.* method group if the scenario requires approval, acknowledgment, or additional information

Relationship with Other ObjectsRelationship with Other Objects

Workflows are linked to Bitrix24 documents, templates, user tasks, and external application handlers.

Document. A process is started for a specific document: a lead, deal, list item, Drive file, or another supported object. The link is passed in the DOCUMENT_ID parameter of the bizproc.workflow.start method. The document type must match the type for which the template was created.

Workflow Template. A template defines the process logic and the set of input parameters. Templates can be managed using the bizproc.workflow.template.* method group. The template identifier TEMPLATE_ID is used when starting a process and filtering the list of active processes.

Workflow Task. A task appears when a process needs a user action: approval, acknowledgment, or additional data input. Tasks can be retrieved using bizproc.task.list, completed using bizproc.task.complete, and delegated using bizproc.task.delegate.

Application. Application automation rules and actions call the external HANDLER. If the handler must return a result to the process, specify output parameters and the response waiting mode during registration, then pass the values using bizproc.event.send.

What to ConsiderWhat to Consider

• Methods for managing templates, automation rules, and actions are executed by an administrator
• Automation rule and action methods work only in the context of an installed application
• An automation rule or action that waits for a result receives EVENT_TOKEN during scenario execution. This key is required for the bizproc.event.send method
• A started process uses a copy of the template as it was at the start time. Changes to the template do not affect an already active process

Overview of MethodsOverview of Methods

Scope: bizproc

Who can execute the method: depends on the method

Main Workflow MethodsMain Workflow Methods

Method	Description
bizproc.workflow.start	Starts a workflow
bizproc.workflow.instances	Retrieves a list of started workflows
bizproc.workflow.kill	Deletes a started workflow along with its data
bizproc.workflow.terminate	Stops workflow execution

Workflow TemplatesWorkflow Templates

Method	Description
bizproc.workflow.template.add	Adds a workflow template from a file
bizproc.workflow.template.update	Updates a workflow template
bizproc.workflow.template.list	Retrieves a list of workflow templates
bizproc.workflow.template.delete	Deletes a workflow template

Workflow TasksWorkflow Tasks

Method	Description
bizproc.task.list	Retrieves a list of workflow tasks
bizproc.task.complete	Completes a workflow task
bizproc.task.delegate	Delegates a workflow task

Application Automation RulesApplication Automation Rules

Method	Description
bizproc.robot.add	Registers an application automation rule
bizproc.robot.update	Updates an application automation rule
bizproc.robot.list	Retrieves a list of application automation rules
bizproc.robot.delete	Deletes an application automation rule
bizproc.event.send	Passes automation rule or action output values to the process

Application ActionsApplication Actions

Method	Description
bizproc.activity.add	Adds an application action
bizproc.activity.update	Updates an application action
bizproc.activity.list	Retrieves a list of application actions
bizproc.activity.delete	Deletes an application action
bizproc.activity.log	Writes a message to the workflow log