Record Header
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
Header of the timeline record HeaderDto.
Parameters of the HeaderDto Object
Required parameters are marked with *
|
Field |
Description |
|
title* |
Title of the record |
|
titleAction |
Action upon clicking the record header |
|
tags |
Associative array of objects describing tags |
TagDtoObject
Tag in the timeline record header.
Warning
No more than two tags are allowed.
Parameters of the TagDto Object
Required parameters are marked with *
|
Field |
Description |
|
title* |
Tag text |
|
type* |
Tag type, for example |
|
action |
Action upon clicking the tag |
|
scope |
Visibility scope, for example |
|
hideIfReadonly |
Flag. Hides the tag if the user does not have edit access (default is |
Possible values for the type field:
- warning - Yellow background
- success - Green background
- failure - Red background
- primary - Blue background
- secondary - Gray background
Note
The image also shows a pale purple tag lavender. It is used in internal timeline records but is not supported in configurable activities: passing it via REST will return a validation error.
Example Object
"header": {
"title": "Incoming call",
"titleAction": {
"type": "redirect",
"uri": "some.url"
},
"tags": {
"status2": {
"type": "warning",
"title": "not transcribed"
}
}
},