Get User Events im.v2.Event.get

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: im

Who can execute the method: authorized user

The method im.v2.Event.get retrieves events for the current user in polling mode.

To receive events, the user must be previously subscribed via im.v2.Event.subscribe. Without a subscription, events are not recorded, and the method will return an empty array.

The method uses confirmation via offset: pass the nextOffset from the previous response to get the next batch of events.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
offset `integer`	Confirms processed events and returns events starting from this value. Pass the `nextOffset` from the previous response
limit `integer`	Maximum number of events returned (1–1000). Default is `100`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"offset":2000,"limit":50}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/im.v2.Event.get

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"offset":2000,"limit":50,"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/im.v2.Event.get

try {
          const response = await $b24.callMethod('im.v2.Event.get', {
            offset: 2000,
            limit: 50,
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'im.v2.Event.get',
                    [
                        'offset' => 2000,
                        'limit' => 50,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'result: ' . print_r($result, true);
        } catch (Throwable $exception) {
            error_log($exception->getMessage());
            echo 'Error: ' . $exception->getMessage();
        }

BX24.callMethod(
            'im.v2.Event.get',
            {
                offset: 2000,
                limit: 50,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'im.v2.Event.get',
            [
                'offset' => 2000,
                'limit' => 50,
            ]
        );
        
        if (!empty($result['error'])) {
            echo 'Error: ' . $result['error_description'];
        } else {
            foreach ($result['result']['events'] as $event) {
                echo $event['type'] . ': ' . $event['eventId'] . "\n";
            }
        }

Response Handling

HTTP Code: 200

{
            "result": {
                "events": [
                    {
                        "eventId": 2001,
                        "type": "ONIMV2MESSAGEADD",
                        "date": "2025-01-15T10:30:00+02:00",
                        "data": {}
                    }
                ],
                "nextOffset": 2002,
                "hasMore": false
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+02:00",
                "date_finish": "2024-10-11T10:00:00+02:00"
            }
        }

Returned Data

Name `Type`	Description
result `object`	Result of the operation
result.events `object[]`	Array of events
result.events[].eventId `integer`	Event ID. Pass in the next call as `offset` for confirmation
result.events[].type `string`	Event type. List of types described below
result.events[].date `datetime`	Date and time of the event
result.events[].data `object`	Event data. Format depends on the event type: event description
result.nextOffset `integer`	Offset for the next request. Pass in the `offset` parameter in the next call
result.hasMore `boolean`	`true` if there are more unprocessed events
time `time`	Information about the request execution time

Event Types

Type	Description
`ONIMV2MESSAGEADD`	New message in chat
`ONIMV2MESSAGEUPDATE`	Message edited
`ONIMV2MESSAGEDELETE`	Message deleted
`ONIMV2REACTIONCHANGE`	Reaction to the message changed
`ONIMV2JOINCHAT`	New participant in the chat

Detailed description of the data format for each event: Event Formats im.v2.

Exclusivity of Event Retrieval

Events for a specific user can only be received by one application. If multiple applications subscribe to the same user, the call with offset confirms and removes records for all — applications will "steal" events from each other.

This limitation is intentional: it is assumed that one agent should respond instantly to events. Multiple agents processing the same events for one user lead to duplicate and conflicting responses.

If multiple independent handlers are needed — use different user contexts or webhook subscriptions.

Error Handling

The method does not generate specific errors. If the user is not subscribed via im.v2.Event.subscribe, the method will return an empty array events.

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Unsubscribe from Events

Event Formats

Get User Events im.v2.Event.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Event TypesEvent Types

Exclusivity of Event RetrievalExclusivity of Event Retrieval

Error HandlingError Handling

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning