Workflows and Automation Rules

Quick navigation: all methods and events

Workflows in Bitrix24 are a low-code tool that allows you to automate everyday tasks without needing deep programming knowledge. Users can easily configure various operations using ready-to-use actions.

You will find these automated processes and can launch them directly from sections such as Feed, CRM, Drive, SPAs, and Universal Lists.

Workflows can be automatically triggered by specific events (for example, when a new deal is added to CRM) or initiated by the user (like the vacation approval process through the Feed).

In addition to workflows, Bitrix24 offers automation rules — an even simpler way to automate tasks, especially convenient for regular users. Automation rules are actively used in CRM and task management.

Popular Scenarios Using REST APIPopular Scenarios Using REST API

With the appropriate methods, you can:

• Add ready-made industry workflow templates accepted in specific business sectors or types of companies
• Propose your scenarios for automatic workflow launches (for example, generating an explanatory note in case of a serious project deadline violation, etc.)
• Offer workflow launches in your widgets if standard interfaces do not provide such an option for the user

You can expand the capabilities of user automation in Bitrix24 by adding your own workflow actions and automation rules that can:

• Send documents to external systems
• Create or modify orders in an external online store
• Transfer data from external systems to Bitrix24
• Launch ready-made external processes (for example, connecting a special external chatbot to a conversation with a client when the deal moves to the delivery approval stage)
• Transfer payment data to external Sales Intelligence
• Execute a completed business scenario (for example, generating a complex invoice or collecting data from all deals of a single client and returning the total for further use)

Features of Workflow FunctionalityFeatures of Workflow Functionality

It is important to understand the terminology and relationships between the objects that implement workflow functionality.

Workflow TemplateWorkflow Template

This is essentially a logical scheme, an algorithm that implements the required business logic using individual actions and operations available in the workflow designer.

A template is always tied to a specific base object, the data of which it will operate on. For example, a template may be linked to CRM deals. In this case, the base object will be a specific deal for which the workflow will be launched.

The binding to the base object also defines the context for launching the workflow: for instance, you cannot launch a workflow for a lead based on a template designed for a deal.

Objects can include leads, contacts, companies, invoices, and estimates in CRM, elements of user-defined object types (SPAs), files in Bitrix24 Drive, and others.

A workflow template can have input parameters that the user (or your code) must fill in when launching the workflow based on the selected template.

In addition to input parameters, internal variables can also be used. The template developer must add them in the template settings.

It is important to understand that when we talk about input parameters and variables, we are referring to "descriptions." However, actual values for parameters and variables only arise when a real workflow is launched.

WorkflowsWorkflows

A workflow is, in fact, a "live" instance created from a template at the moment of launch for a specific base object. Clearly, multiple workflows can be launched simultaneously for different base objects.

When a workflow is launched, a copy of the workflow template is created, which remains unchanged until the workflow is completed. If the user makes changes to the template during the execution of the workflow, it will not affect the logic of the already launched workflow.

The values of input parameters and internal variables also have specific values for each individual workflow and change only for it.

Workflow TasksWorkflow Tasks

During execution, a workflow can use special actions — tasks for workflow participants, when the logic of the workflow requires obtaining additional information from the user, such as approving a document, uploading a file, and so on.

Such actions generate workflow tasks. Users who receive tasks see the corresponding information in Bitrix24 and also receive notifications. The current tasks for a user can also be retrieved using the corresponding REST API method for automatic processing.

Workflow ActionsWorkflow Actions

Actions of a workflow are the "blocks" from which the workflow template is built. Typically, they represent isolated atomic operations like "Create Task," "Generate Invoice," "Change Document Field Value," and so on.

Workflow actions can have input parameters that the user can specify in the workflow designer during the development of the desired template.

Additionally, actions can return resulting data "back" to the workflow. This data can be used by the workflow designer as input parameters for subsequent actions.

Using the REST API, you can add your own actions to workflows in Bitrix24.

Automation RulesAutomation Rules

Automation rules are objects similar to workflow actions, with the main difference being that they are primarily used not in the workflow designer but in special interfaces of CRM and tasks.

Automation rules can also have input parameters, the values of which will be set by the user configuring the rules in lead funnels, deals, or smart scenarios. They can also return values for use as input parameters for subsequent automation rules.

Using the REST API, you can add your own automation rules to Bitrix24. We recommend adding automation rules instead of workflow actions, as automation rules can be used within the workflow designer, meaning you will add your functionality to both the automation rules settings and the workflow designer at once.

Recommended Learning SequenceRecommended Learning Sequence

• Add your automation rule to Bitrix24
• Learn how to start a ready-made workflow or stop an already launched one
• Discover how to add your template
• Learn how to get a list of current workflow tasks, automatically complete them for the user, and delegate to another user

Overview of MethodsOverview of Methods

Method	Description
bizproc.workflow.start	Starts a new workflow
bizproc.workflow.instances	Returns a list of launched workflows
bizproc.workflow.kill	Deletes a launched workflow along with all process data
bizproc.workflow.terminate	Interrupts the execution of a workflow

Workflow TemplatesWorkflow Templates

Method	Description
bizproc.workflow.template.add	Adds a new workflow template
bizproc.workflow.template.update	Updates an existing workflow template
bizproc.workflow.template.delete	Deletes a workflow template
bizproc.workflow.template.list	Returns a list of workflow templates

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 a new automation rule
bizproc.robot.update	Updates fields of an already added automation rule
bizproc.robot.list	Returns a list of automation rules registered by the application
bizproc.robot.delete	Deletes a registered automation rule
bizproc.event.send	Returns output parameters for the action specified in the action description

Application ActionsApplication Actions

Method	Description
bizproc.activity.add	Adds a new action for use in workflows
bizproc.activity.update	Updates fields of an already added action
bizproc.activity.list	Returns a list of actions installed by the application
bizproc.activity.log	Records information in the workflow log
bizproc.activity.delete	Deletes an action installed by the application