Click Reaction

ActionDto is the reaction to a click on an element of a timeline record. There are three types of actions, and each is described by its own set of fields:

The action is set in the following fields:

• titleAction of the heading — optional
• action of a tag — optional
• action of the logo in the content area — optional
• action of a link block in content blocks — required
• action of a button in the bottom part — required
• action of a menu item — required

The type field is required. A value outside the list is rejected by the method with the ENUM_FIELD error, and a field that belongs to none of the three sets — with the FIELD_IS_REDUNDANT error. Bitrix24 does not reject fields of a different action type, but does not use them either.

Link Navigation redirectLink Navigation redirect

A relative link to a standard Bitrix24 object that supports a slider opens the slider. Other relative links open as a regular redirect. A link specifying a domain is considered external and opens in a new browser tab.

ParametersParameters

Required parameters are marked with *

ExampleExample

{
            "type": "redirect",
            "uri": "/crm/deal/details/1/"
        }
        

Event restEventEvent restEvent

To receive the onCrmTimelineItemAction event, the application subscribes to it with the event.bind method or declares a handler during installation.

The event is received only by the application that set the action: for a configurable activity — the application that created the activity, for additional content blocks — the application that installed the blocks. Other applications do not receive the event.

The context is always passed to the handler:

The values from actionParams are passed through the user's browser, so secrets and tokens must not be put there.

The user who clicked is identified by the standard auth[user_id] field of the event — it does not get into the action context.

ParametersParameters

Required parameters are marked with *

The event handler often changes the record itself: it adds blocks or replaces the set of buttons. While the event is being processed, animationType shows the user that the click has been accepted:

The block is not released automatically: it persists until the application updates the activity with the crm.activity.configurable.update method.

ExampleExample

{
            "type": "restEvent",
            "id": "resetButtonClick",
            "actionParams": {
                "myId": 123,
                "someImportant": "qwerty"
            },
            "animationType": "disable"
        }
        

Such an action is assigned to a button or a menu item. Besides the context fields, the handler receives myId and someImportant set by the application.

Opening the Application Slider openRestAppOpening the Application Slider openRestApp

The slider opens on top of the timeline, and the application interface runs inside it. The context is passed to the slider:

ParametersParameters

Required parameters are marked with *

ExampleExample

{
            "type": "openRestApp",
            "actionParams": {
                "myId": 123,
                "someImportant": "qwerty"
            },
            "sliderParams": {
                "title": "This is the application slider header",
                "width": 700
            }
        }
        

ObjectActionSliderParamsDtoObject

The object sets the slider size, the browser window title, and the label in the header. All of its fields are optional: without sliderParams the slider opens with the default settings.

Parameters of the ObjectParameters of the ActionSliderParamsDto Object

Continue LearningContinue Learning

• Structure of Configurable Activity
• Icon
• Record Header
• Main Content Area of Configurable Activity
• Configurable Activity Content Block
• Bottom Part of a Configurable Activity Record
• Bottom Dropdown Menu
• Field Types
• Set of Additional Content Blocks
• Activity Configuration Examples