When Adding a Message to the Chat OnOpenLineMessageAdd

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.

Scope: imopenlines

Who can subscribe: any user

The OnOpenLineMessageAdd event is triggered when a message is added to the open line chat.

Subscribe to the event can only be done through the application. Only those events intended for the connector added by the application can be received in the handler.

Events will not be sent to the application until the installation is complete. Check the application installation

What the Handler Receives

Data is transmitted as a POST request

{
            "event": "ONOPENLINEMESSAGEADD",
            "eventId": 1,
            "data": {
                "DATA": [
                    {
                        "connector": {
                            "connector_id": "livechat",
                            "line_id": 128,
                            "chat_id": 10587,
                            "user_id": 1985
                        },
                        "chat": {
                            "id": 10585
                        },
                        "message": {
                            "id": 80964,
                            "date": "",
                            "text": "hello",
                            "files": [],
                            "attach": "",
                            "system": "N",
                            "user_id": 1985
                        },
                        "ref": [],
                        "extra": {
                            "EXTRA_URL": ""
                        }
                    }
                ]
            },
            "ts": 1714649632,
            "auth": {
                "access_token": "s6p6eclrvim6da22ft9ch94ekreb52lv",
                "expires_in": 3600,
                "scope": "imopenlines",
                "domain": "some-domain.bitrix24.com",
                "server_endpoint": "https://oauth.bitrix.info/rest/",
                "status": "F",
                "client_endpoint": "https://some-domain.bitrix24.com/rest/",
                "member_id": "a223c6b3710f85df22e9377d6c4f7553",
                "refresh_token": "4s386p3q0tr8dy89xvmt96234v3dljg8",
                "application_token": "51856fefc120afa4b628cc82d3935cce"
            }
        }

Required parameters are marked with *

parameter
type

Description

event*
string

Symbolic code of the event.

In this case — ONOPENLINEMESSAGEADD

eventId*
integer

Event identifier

data*
object

An object containing event data.

The structure is described below

ts*
timestamp

Date and time of the event sent from the event queue

auth*
object

Object containing authorization parameters and information about the account where the event occurred.

The structure is described below

Parameter data

parameter
type

Description

DATA*
array

An array of objects with message data.

The object structure is described below

Array Element DATA

Each array element DATA is an object with the following structure:

parameter
type

Description

connector*
object

An object with connector information.

The structure is described below

chat*
object

An object with chat information.

The structure is described below

message*
object

An object with message information.

The structure is described below

ref*
array

An array with the tracker code trackId to link the message to a CRM object. In the example, it is passed as empty

extra*
object

An object with additional information.

The structure is described below
Parameter connector

parameter
type

Description

connector_id*
string

Connector identifier

line_id*
integer

Identifier of the open line

chat_id*
integer

Identifier of the chat

user_id*
integer

User ID in the external system
Parameter chat

parameter
type

Description

id*
integer

Identifier of the chat
Parameter message

parameter
type

Description

id*
integer

Identifier of the message

date*
string

Date and time the message was added

text*
string

Text of the message

files*
array

Message files

attach*
string

Attached data

system*
string

A flag indicating that the message is a system message: Y — yes, N — no

user_id*
integer

User identifier
Parameter extra

parameter
type

Description

EXTRA_URL*
string

External link for Bitrix24.Network

Parameter auth

Required parameters are marked with *

Name
type

Description

access_token
string

Authorization token OAuth 2.0

expires_in
integer

Time in seconds until the token expires

scope*
string

Scope under which the event occurred

domain*
string

Address of Bitrix24 where the event occurred

server_endpoint*
string

Address of the Bitrix24 authorization server needed to refresh OAuth 2.0 tokens

status*
string

Status of the application that subscribed to this event:

  • L — local application
  • F — free mass-market application
  • D — demo version of a mass-market application
  • T — trial version of a mass-market application, time-limited
  • P — paid mass-market application

client_endpoint*
string

Common path for REST API method calls for Bitrix24 where the event occurred

member_id*
string

Identifier of Bitrix24 where the event occurred

refresh_token
string

Token for extending authorization OAuth 2.0

application_token*
string

Token for secure event handling

Authorization tokens are not always passed to the event handler. If the hit that initiated the event could not be linked to a specific Bitrix24 user, the tokens are not passed. Always check the contents of the auth key in the code.

It is recommended to store tokens obtained earlier during the application installation. Use them when working with the application interface in the form of embeds, widgets, and so on.

Continue Learning

Previous
When Creating a Session
Next
When Updating a Message