CRM Timeline Comments: Overview of Methods and Events

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.

Timeline comments capture agreements, clarifications, and service notes within the CRM card. For instance, a manager might leave a comment about the outcome of a call or attach a file with a contract.

The methods in this section help manage such records: creating, retrieving, updating, and deleting comments. Events allow for real-time tracking of changes.

Quick navigation: all methods and events

User documentation: Timeline in CRM item form

Connection to Other Objects

Comments exist only in relation to CRM entities.

CRM Entity. The connection between a comment and an entity is defined by the parameters ENTITY_TYPE and ENTITY_ID.

  • ENTITY_TYPE stores the type of CRM object. You can find the type values in the CRM Object Type Reference.
  • ENTITY_ID stores the identifier of the CRM entity. It is returned by list methods and creation methods, such as crm.item.list and crm.item.add.

The parameters ENTITY_TYPE and ENTITY_ID are used in the methods crm.timeline.comment.add and crm.timeline.comment.list.

Files. A comment can contain attachments in the FILES field. The format for file transmission is described in the articles How to Upload Files and How to Update Files.

The FILES field is processed by the methods crm.timeline.comment.add and crm.timeline.comment.update, while attachments are returned in the responses of crm.timeline.comment.get and crm.timeline.comment.list.

How to Work with Comments

  1. Identify the CRM entity to which the comment pertains.
  2. Check the access permissions for the CRM entity; otherwise, the methods may return an Access denied error. Access depends on the current user's rights to the specific entity.
  3. Retrieve the list of available fields using the method crm.timeline.comment.fields.
  4. Add a comment using the method crm.timeline.comment.add.
  5. Retrieve the list of comments using the method crm.timeline.comment.list or the data for a specific comment using the method crm.timeline.comment.get.
  6. Modify the comment using the method crm.timeline.comment.update.
  7. Delete any unnecessary comments using the method crm.timeline.comment.delete.
  8. To track changes, subscribe to events in the Comment Events section.

Overview of Methods and Events

Scope: crm

Who can execute the methods: any user

Method

Description

crm.timeline.comment.add

Adds a new comment to the timeline

crm.timeline.comment.update

Updates a comment

crm.timeline.comment.get

Retrieves information about a comment

crm.timeline.comment.list

Retrieves a list of comments for a CRM entity

crm.timeline.comment.delete

Deletes a comment

crm.timeline.comment.fields

Retrieves a list of timeline comment fields

Event

Triggered

onCrmTimelineCommentAdd

When a new comment is created in the timeline manually or via the method crm.timeline.comment.add

onCrmTimelineCommentUpdate

When a comment is updated in the timeline manually or via the method crm.timeline.comment.update

onCrmTimelineCommentDelete

When a comment is deleted in the timeline manually or via the method crm.timeline.comment.delete
Previous
Get Fields of Timeline Record Relationships and CRM Entities
Next
Add Comment