Icon

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

IconDto is the icon to the left of the timeline entry. It tells the user at a glance what the entry is about: a call, a document, a message. An icon is not a logo: LogoDto is a large image inside the content area, while the icon occupies a narrow column to the left of the whole entry.

The object is passed in the icon field of the configurable activity structure, and the structure itself is passed in the layout parameter of the crm.activity.configurable.add and crm.activity.configurable.update methods. The icon field is required: without it the method returns the FIELD_IS_REQUIRED error. The calling conditions are described on the structure page.

Parameters of the IconDto Object

Required parameters are marked with *

Field

Description

code*
string

Icon code, for example call-completed

The object has no other fields. An extra field is rejected by the method with the FIELD_IS_REDUNDANT error, and an unknown icon code with the ENUM_FIELD error.

How to Choose an Icon Code

Bitrix24 has a set of system icons for typical timeline events. The full list is returned by the crm.timeline.icon.list method. Each icon in the response has a code and an isSystem flag: true — a Bitrix24 icon, false — an icon uploaded by an application.

Frequently used codes:

Code

For Which Entry

call, call-incoming, call-outcoming, call-completed, call-incoming-missed

Calls: general, incoming, outgoing, completed, missed

sms, telegram, whatsapp, IM

Messages in the corresponding channel

mail-outcome

Outgoing email

document

Document

task

Task

info

Information message

check, circle-check, complete

Confirmation or completion

clock

Reminder, waiting

stage-change, pipeline

Stage change, work with a pipeline

If there is no suitable icon, upload your own with the crm.timeline.icon.add method. The application sets the code for it, and after registration the same code is passed in the code field of the activity structure. The crm.timeline.icon.get method verifies that the icon is registered.

Example of the Object

The value of the icon field: the icon of a completed call.

{
            "code": "call-completed"
        }

The icon as part of a complete structure is in the LayoutDto object example.

Continue Exploring

Previous
Structure Overview
Next
Record Title