Flows: Overview of Methods

Flows are a tool that automates the distribution and execution of tasks. Employees do not need to search for who will complete a task. They assign tasks to the department's flow, and it automatically assigns an assignee.

In the flow, you can track the efficiency of task completion. Efficiency is calculated using the formula: <number of overdue tasks> / <total number of tasks in the flow> * 100%. To improve efficiency, change the type of task distribution or the flow team.

Quick navigation: all methods

User documentation: Bitrix24 Flows: Getting Started

Types of DistributionTypes of Distribution

• Manual distribution manually. All tasks are assigned to the flow moderator. The moderator distributes tasks among employees.
• Queue distribution queue. Tasks are assigned in turn to each team member. A member will be skipped if they are absent from work, for example, on vacation or sick leave.
• Self-assignment himself. Tasks are assigned to the creator. Each team member in the flow will receive a notification. A flow member will become the assignee if they click the Take to Work button. If a task is taken to work, the system will change the task status to In Progress.

If there are no employees left in the flow team with queue distribution or self-assignment, the flow will automatically switch to manual distribution mode. The flow administrator will become the moderator and receive a notification.

Relationships with Other ObjectsRelationships with Other Objects

Group. The flow is linked to a group by the identifier groupId. You can obtain the identifier using the create new group method or the get list of groups method. If the group identifier is not specified when creating the flow, a new group will be created.

User. The flow is linked to a user by the flow administrator identifier ownerId. You can obtain the user identifier using the user.get method. If the identifier is not specified when creating the flow, the creator will become the flow administrator.

Task Template. Flow tasks are created based on a template. The template identifier is specified in templateId.

How to Add a Task to the FlowHow to Add a Task to the Flow

You can add a task to a flow using the create new task method or the update existing task method. Specify the flow identifier in the FLOW_ID parameter.

Bitrix24 will automatically fill in all the necessary fields for the flow according to the flow settings.

The title and assignee are required fields when creating a task outside the flow. In the case of tasks in the flow, it is sufficient to fill in FLOW_ID and the title. The flow will assign the assignee.

Enable or Disable the FlowEnable or Disable the Flow

If you need to temporarily stop working with the flow, you can disable it. The flow can be enabled or disabled using the method tasks.flow.Flow.activate by the identifier flowId.

You can obtain the flow identifier using the create new flow method or the get task information method for a task from the flow.

Check Flow Name UniquenessCheck Flow Name Uniqueness

The flow name must be unique. You can check the uniqueness of the name using the method tasks.flow.Flow.isExists.

Overview of MethodsOverview of Methods

Scope: task

Who can execute the method: depending on the method

Method	Description
tasks.flow.Flow.create	Creates a flow
tasks.flow.Flow.update	Updates a flow
tasks.flow.Flow.get	Retrieves a flow
tasks.flow.Flow.delete	Deletes a flow
tasks.flow.Flow.isExists	Checks whether a flow with this name exists
tasks.flow.Flow.activate	Enables or disables a flow
tasks.flow.Flow.pin	Pins or unpins a flow in the list