Create a Flow tasks.flow.Flow.create
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:
taskWho can execute the method: Bitrix24 administrator or a user with the permission to create flows. Extranet users cannot create flows
The method tasks.flow.Flow.create creates a flow.
A flow is always linked to a group. If groupId is not passed, a new group is created. It includes the flow creator, the flow administrator, and the flow team.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
flowData* |
Field values for creating the flow (detailed description) |
Parameter flowData
Required parameters are marked with *
|
Name |
Description |
|
name* |
The name of the flow, from 1 to 255 characters. Must be unique within Bitrix24. You can check the name using the method tasks.flow.Flow.isExists |
|
description |
Description of the flow |
|
groupId |
The ID of the group to which the flow will be linked. If not specified, the method creates a new group named after the flow. If a group with this name already exists, the method returns the |
|
ownerId |
The ID of the flow administrator. If not specified, the creator will be the flow administrator |
|
templateId |
The ID of the template that users will use to add tasks to the flow |
|
plannedCompletionTime* |
Number of seconds allowed to complete a task, at least |
|
distributionType* |
Type of distribution:
More about distribution types can be found in the article Flows: Overview of Methods |
|
responsibleList* |
Employees or departments that will receive tasks. Each element is a "type — ID" pair. For manual distribution, specify a single pair with the flow moderator, for example For self-distribution or queue distribution, specify employees or departments. For example:
A department without the |
|
taskCreators |
Who can add tasks to the flow: users or departments. Each element is a
A department without the To allow all users to add tasks, pass the pair |
|
matchWorkTime |
Skip weekends and holidays when calculating the task deadline. Accepts values |
|
matchSchedule |
Count the task completion time only during working hours according to the work schedule. Accepts values |
|
responsibleCanChangeDeadline |
Can the responsible person change the task deadline. Accepts values |
|
notifyAtHalfTime |
Notify the performer at half the task deadline. Accepts values |
|
taskControl |
Send the completed task to the creator for review. Accepts values |
|
notifyOnQueueOverflow |
Number of tasks in the queue above which the flow administrator receives a notification. Default is |
|
notifyOnTasksInProgressOverflow |
Number of tasks in progress above which the flow administrator receives a notification. Default is |
|
notifyWhenEfficiencyDecreases |
Efficiency percentage below which the flow administrator receives a notification. Default is |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"flowData": {
"name": "Unique Flow Name",
"description": "Flow description",
"plannedCompletionTime": 7200,
"distributionType": "manually",
"responsibleList": [["user","3"]],
"taskCreators": [["meta-user","all-users"]],
"matchWorkTime": 1,
"notifyAtHalfTime": 0
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.flow.Flow.create
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"flowData": {
"name": "Unique Flow Name",
"description": "Flow description",
"plannedCompletionTime": 7200,
"distributionType": "manually",
"responsibleList": [["user","3"]],
"taskCreators": [["meta-user","all-users"]],
"matchWorkTime": 1,
"notifyAtHalfTime": 0
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/tasks.flow.Flow.create
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type FlowCreateResult = {
id: number
creatorId: number
ownerId: number
groupId: number
templateId: number
efficiency: number
active: boolean
plannedCompletionTime: number
activity: ISODate
name: string
description: string
distributionType: string
responsibleList: string[][]
demo: boolean
responsibleCanChangeDeadline: boolean
matchWorkTime: boolean
matchSchedule: boolean
taskControl: boolean
notifyAtHalfTime: boolean
notifyOnQueueOverflow: number | null
notifyOnTasksInProgressOverflow: number | null
notifyWhenEfficiencyDecreases: number | null
taskCreators: string[][]
team: string[][]
trialFeatureEnabled: boolean
}
try {
const response = await $b24.actions.v2.call.make<FlowCreateResult>({
method: 'tasks.flow.Flow.create',
params: {
flowData: {
name: 'Unique Flow Name',
description: 'Flow description',
plannedCompletionTime: 7200,
distributionType: 'manually',
responsibleList: [['user', '3']],
taskCreators: [['meta-user', 'all-users']],
matchWorkTime: 1,
notifyAtHalfTime: 0,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Created flow:', result.id, result.name, result.active)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function createFlow() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.flow.Flow.create',
params: {
flowData: {
name: 'Unique Flow Name',
description: 'Flow description',
plannedCompletionTime: 7200,
distributionType: 'manually',
responsibleList: [['user', '3']],
taskCreators: [['meta-user', 'all-users']],
matchWorkTime: 1,
notifyAtHalfTime: 0,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Created flow:', result.id, result.name, result.active)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', createFlow)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
flow_data = {
"name": "Unique Flow Name",
"description": "Flow description",
"plannedCompletionTime": 7200,
"distributionType": "manually",
"responsibleList": [
[
"user",
"3",
],
],
"taskCreators": [
[
"meta-user",
"all-users",
],
],
"matchWorkTime": 1,
"notifyAtHalfTime": 0,
}
try:
bitrix_response = client.tasks.flow.flow.create(
flow_data=flow_data,
).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 {
$response = $b24Service
->core
->call(
'tasks.flow.Flow.create',
[
'flowData' => [
'name' => 'Unique Flow Name',
'description' => 'Flow description',
'plannedCompletionTime' => 7200,
'distributionType' => 'manually',
'responsibleList' => [
['user', '3']
],
'taskCreators' => [
['meta-user', 'all-users']
],
'matchWorkTime' => 1,
'notifyAtHalfTime' => 0
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating flow: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.flow.Flow.create',
{
flowData: {
name: 'Unique Flow Name',
description: 'Flow description',
plannedCompletionTime: 7200,
distributionType: 'manually',
responsibleList: [
[
'user','3'
]
],
taskCreators: [
[
'meta-user','all-users'
]
],
matchWorkTime: 1,
notifyAtHalfTime: 0
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php'); // connecting CRest PHP SDK
$flowData = [
"name" => "Unique Flow Name",
"description" => "Flow description",
"plannedCompletionTime" => 7200,
"distributionType" => "manually",
"responsibleList" => [["user", "3"]],
"taskCreators" => [["meta-user", "all-users"]],
"matchWorkTime" => 1,
"notifyAtHalfTime" => 0
];
// executing a request to the REST API
$result = CRest::call(
'tasks.flow.Flow.create',
[
'flowData' => $flowData
]
);
// Processing the response from Bitrix24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "tasks.flow.Flow.create", b24.Params{
"flowData": b24.Params{
"name": "Unique Flow Name",
"description": "Flow description",
"plannedCompletionTime": 7200,
"distributionType": "manually",
"responsibleList": []any{
[]string{"user", "3"},
},
"taskCreators": []any{
[]string{"meta-user", "all-users"},
},
"matchWorkTime": 1,
"notifyAtHalfTime": 0,
},
})
if err != nil {
return fmt.Errorf("tasks.flow.Flow.create: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
CreatorID b24.ID `json:"creatorId"`
OwnerID b24.ID `json:"ownerId"`
GroupID b24.ID `json:"groupId"`
TemplateID b24.ID `json:"templateId"`
Efficiency int `json:"efficiency"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.CreatorID)
Response Handling
HTTP status: 200
{
"result": {
"id": 7,
"creatorId": 1,
"ownerId": 1,
"groupId": 6,
"templateId": 0,
"efficiency": 100,
"active": true,
"plannedCompletionTime": 7200,
"activity": "2026-11-06T11:59:13+03:00",
"name": "Unique Flow Name",
"description": "Flow description",
"distributionType": "manually",
"responsibleList": [
[
"user",
"3"
]
],
"demo": false,
"responsibleCanChangeDeadline": true,
"matchWorkTime": true,
"matchSchedule": false,
"taskControl": false,
"notifyAtHalfTime": false,
"notifyOnQueueOverflow": null,
"notifyOnTasksInProgressOverflow": null,
"notifyWhenEfficiencyDecreases": null,
"taskCreators": [],
"team": [],
"trialFeatureEnabled": false
},
"time": {
"start": 1793955553,
"finish": 1793955554.612625,
"duration": 1.6126248836517334,
"processing": 1,
"date_start": "2026-11-06T11:59:13+03:00",
"date_finish": "2026-11-06T11:59:14+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Object containing flow data (detailed description) |
|
time |
Information about the request execution time |
Object result
|
Name |
Description |
|
id |
ID of the created flow |
|
creatorId |
ID of the flow creator |
|
ownerId |
ID of the flow administrator |
|
groupId |
ID of the group to which the flow is linked |
|
templateId |
ID of the template used to create tasks in the flow |
|
efficiency |
Efficiency of the flow in percentage |
|
active |
Whether the flow is enabled |
|
plannedCompletionTime |
Number of seconds allowed to complete a task, at least |
|
activity |
Date and time of the last activity in the flow |
|
name |
Flow name |
|
description |
Description of the flow |
|
distributionType |
Type of task distribution in the flow |
|
responsibleList |
List of responsible persons for tasks in the flow, with "type — ID" pairs as elements. For manual distribution, this is the flow moderator |
|
demo |
Indicates whether the flow is a demo. System parameter |
|
responsibleCanChangeDeadline |
Can the responsible person change the task deadline |
|
matchWorkTime |
Whether to skip weekends and holidays when calculating the task deadline |
|
matchSchedule |
Whether to count the task completion time only during working hours according to the work schedule |
|
taskControl |
Whether to send the completed task to the creator for review |
|
notifyAtHalfTime |
Whether to notify the performer at half the task deadline |
|
notifyOnQueueOverflow |
Number of tasks in the queue above which the flow administrator receives a notification. |
|
notifyOnTasksInProgressOverflow |
Number of tasks in progress above which the flow administrator receives a notification. |
|
notifyWhenEfficiencyDecreases |
Efficiency percentage below which the flow administrator receives a notification. |
|
taskCreators |
Who can add tasks to the flow. Each element is a "type — ID" pair, for example In the response of this method, the field is empty even if task creators are set. The current list is returned by the tasks.flow.Flow.get method |
|
team |
Flow team. For manual distribution, this includes all members of the group linked to the flow, except for the moderator. For queue and self-distribution, the team is the same as in Elements are "type — ID" pairs, as in |
|
trialFeatureEnabled |
Indicates whether the trial period is enabled for the flow. System parameter |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "'responsibleList': field's value must not be empty"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Cannot find flow |
The user does not have the permission to create flows, a group with this |
|
|
|
Property name cannot be null |
A required field is not passed. Instead of |
|
|
|
'name': field's length must be greater than 1 and less than 255 |
The name is empty or longer than 255 characters |
|
|
|
'plannedCompletionTime': field's value must be greater than 3600 |
The completion time is less than an hour: |
|
|
|
distributionType: unexpected value |
|
|
|
|
'responsibleList': field's value must not be empty |
|
|
|
|
Template 99999 doesn't exists |
A template with this |
|
|
|
A flow with this name already exists |
The flow name is already taken in Bitrix24. You can check the name in advance using the method tasks.flow.Flow.isExists |
|
|
|
Workgroup with this name already exists |
|
|
|
|
Unknown error. [Flow: 198] |
Internal error. The number in brackets indicates where in the code the error occurred; it helps support find the cause |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |