Bottom Part of a Configurable Activity Record
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
An application displays its own actions below a configurable activity record in a CRM card timeline — for example, to confirm a request or open a related deal. These actions are defined by the FooterDto object. It describes the bottom part of the timeline record: buttons, the "Note" icon, and the menu that opens from the three-dot icon.
The object is passed in the footer field of the configurable activity structure when calling the crm.activity.configurable.add and crm.activity.configurable.update methods. The path in the request is layout.footer: buttons go in layout.footer.buttons, menu items in layout.footer.menu.items.
Menu items are described on the dropdown menu page. Ready-made field combinations are collected in the activity configuration examples.
Buttons or Menu
An application can show its actions in two ways:
- buttons — up to two, displayed right below the record and intended for primary actions
- menu items — up to ten, available from the three-dot icon and optionally grouped into sections with headings
Bitrix24 adds some elements itself: the "Note" icon and the "Pin", "Postpone", and "Delete" system menu items. Fields of the object can disable them. The "About the application" item is always present in the browser. If footer is not passed, the record shows only these system elements, without application buttons.
Parameters of the FooterDto Object
|
Field |
Description |
|
buttons |
Action buttons: the key is a button identifier that you choose, the value is a FooterButtonDto object. The key can contain Latin letters, digits, hyphens, and underscores. Pass no more than two buttons |
|
showNote |
If |
|
menu |
The menu that opens from the three-dot icon |
If the structure violates these restrictions, the method returns a validation error. General codes are listed on the crm.activity.configurable.add and crm.activity.configurable.update pages, and codes for menu sections are in the FooterMenuDto description.
Pass buttons as an object with keys. The method accepts an array without keys and returns no error, but the buttons do not appear in the record.
FooterButtonDtoObject
A button in the bottom part of the timeline record.
Parameters of the FooterButtonDto Object
Required parameters are marked with *
|
Field |
Description |
|
title* |
Button text |
|
type* |
Button style: |
|
action* |
Action to be performed when the button is clicked |
|
scope |
Scope, e.g., |
|
hideIfReadonly |
If |
FooterMenuDtoObject
The menu that opens from the three-dot icon. The showPinItem, showPostponeItem, and showDeleteItem flags disable system items, and the items and sections fields define the application's items.
Parameters of the FooterMenuDto Object
|
Field |
Description |
|
showPinItem |
If |
|
showPostponeItem |
If |
|
showDeleteItem |
If |
|
items |
Application items: the key is the item identifier, the value is a MenuItemDto object. No more than ten items |
|
sections |
Menu sections with headings — an array of |
If menu sections are set incorrectly, the method returns one of the following codes:
|
Code |
Reason |
|
|
The section code matches a reserved one: |
|
|
Two sections have the same code |
|
|
Sections are passed, but an item has no |
|
|
The item's |
Object Example
The value of the footer field with two buttons. Only users with permission to edit the deal see the "Confirm request" button. The "Open deal" button is shown only in the browser. There is no "Note" icon. The menu contains the "Decline request" application item, and the "Postpone" and "Delete" system items are disabled.
{
"buttons": {
"confirm": {
"title": "Confirm request",
"type": "primary",
"action": {
"type": "restEvent",
"id": "confirm",
"animationType": "loader"
},
"hideIfReadonly": true
},
"open": {
"title": "Open deal",
"type": "secondary",
"action": {
"type": "redirect",
"uri": "/crm/deal/details/123/"
},
"scope": "web"
}
},
"showNote": false,
"menu": {
"showPostponeItem": false,
"showDeleteItem": false,
"items": {
"decline": {
"title": "Decline request",
"action": {
"type": "restEvent",
"id": "decline",
"animationType": "loader"
}
}
}
}
}
Permissions and Limitations
Scope:
crmWho can execute the method: a user with edit access to the CRM object the activity is linked to. Without such access the method returns the
ACCESS_DENIEDerror
Limitations:
- the crm.activity.configurable.add and crm.activity.configurable.update methods work only within the context of an application: when they are called via a webhook, Bitrix24 returns the
ERROR_WRONG_CONTEXTerror - only the application that created the activity can update it with the crm.activity.configurable.update method