index.md

Log Record Journal: Overview of Methods

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

The log record journal serves as a utility for secondary events in the timeline. In the interface, these records are presented with a lower visual priority: a subdued icon and less emphasis compared to key events.

Quick Navigation: All Methods

User Documentation: Timeline in CRM item form

How to Work with the Log Record Journal

1. Add a record using the crm.timeline.logmessage.add method.
2. Retrieve a record by its ID using the crm.timeline.logmessage.get method.
3. Output a list of records for a CRM object using the crm.timeline.logmessage.list method.
4. Delete a record using the crm.timeline.logmessage.delete method if it is no longer needed.
5. Customize the appearance of the record through the icon and logo sections.

Key Limitations of the Section

• The methods crm.timeline.logmessage.get and crm.timeline.logmessage.list only return records created by the crm.timeline.logmessage.add method, including records of other applications. System records cannot be retrieved using these methods.
• A record can only be deleted using the crm.timeline.logmessage.delete method in the context of the application that created it.

Relationship with Other Objects

CRM Entities. A log record is created for a specific CRM object through the fields.entityTypeId and fields.entityId fields of the crm.timeline.logmessage.add method.

Log Record Icons. The set of icons can be managed using the crm.timeline.icon.* methods, and then the icon code is used in fields.iconCode when creating a record.

Log Record Logos. The set of logos can be managed using the crm.timeline.logo.* methods to maintain a consistent visual style for log records.

How to Choose an Icon or Logo

• Use crm.timeline.icon.* when you need to quickly label the type of event in the log record via fields.iconCode.
• Use crm.timeline.logo.* when a separate set of branded images for log records is required.
• Before adding a record, check the available codes through crm.timeline.icon.list and crm.timeline.logo.list.

Overview of Methods {#all-methods}

Scope: crm

Who can execute the method: depends on the method

Core

#| || Method | Description || || crm.timeline.logmessage.add | Adds a new log record to the timeline || || crm.timeline.logmessage.get | Retrieves information about a log record || || crm.timeline.logmessage.list | Retrieves a list of all log records for a specific entity || || crm.timeline.logmessage.delete | Deletes a log record || |#

Icons

#| || Method | Description || || crm.timeline.icon.add | Adds a new icon || || crm.timeline.icon.get | Retrieves information about an icon || || crm.timeline.icon.list | Retrieves a list of all available icons || || crm.timeline.icon.delete | Deletes an icon || |#

Logos

#| || Method | Description || || crm.timeline.logo.add | Adds a new logo || || crm.timeline.logo.get | Retrieves information about a logo || || crm.timeline.logo.list | Retrieves a list of all available logos || || crm.timeline.logo.delete | Deletes a logo || |#