Get Events from imbot.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: imbot

Who can execute the method: owner of the registered bot

The method imbot.v2.Event.get retrieves events for the bot in polling agent mode. It is used for bots with eventMode: "fetch".

The method confirms the receipt of events with IDs less than the provided offset. On the next call, only new events starting from the confirmed ones are returned.

Only one application—the one that registered the bot—can receive events for a specific bot. If multiple independent agents are needed, register a separate bot for each.

When to Use `imbot.v2.Event.get`

This method is suitable if:

the bot does not have a public URL for incoming HTTP requests
events need to be fetched by a single background agent (worker) on a schedule
explicit control of the event queue is required through offset and nextOffset
bot events ONIMBOTV2* and user events ONIMV2* need to be received in a single stream via withUserEvents

Alternative: Webhook Mode

Instead of polling, you can use webhook mode:

In imbot.v2.Bot.register, specify fields.eventMode = webhook
Set fields.webhookUrl to receive incoming events
Example of a webhook handler

Step-by-step setup for both options: Quick Start.

Method Parameters

Required parameters are marked with *

Name `Type`	Description
botId* `integer`	Bot ID
botToken `string`	Unique authorization token for the bot. Required for webhook authorization, not needed for OAuth. Pass the same botToken that was specified during chat bot registration
offset `integer`	Confirms all events with IDs less than the specified value. Not passed on the first call
limit `integer`	Maximum number of events returned (1–1000). Default is `100`
withUserEvents `boolean`	Include user events (`ONIMV2*`) in the response along with bot events. Default is `false`. More details — below

Retrieving Bot and User Events

When withUserEvents: true, the method returns both bot events ONIMBOTV2* and user events ONIMV2* in a single response.

Requirements:

The application must have the im scope in addition to imbot
The current user must be subscribed via im.v2.Event.subscribe
userId is determined from the authorization—specifying someone else's is not possible

One offset confirms both bot events and user events simultaneously.

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"botId":456,"botToken":"my_bot_token","offset":1000,"limit":50,"withUserEvents":true}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Event.get

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

try {
          const response = await $b24.callMethod('imbot.v2.Event.get', {
            botId: 456,
            offset: 1000,
            limit: 50,
            withUserEvents: true,
          });
        
          const { result } = response.getData();
          console.log('result:', result);
        } catch (error) {
          console.error('Error:', error);
        }

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

BX24.callMethod(
            'imbot.v2.Event.get',
            {
                botId: 456,
                offset: 1000,
                limit: 50,
                withUserEvents: true,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

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

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 '{"botId":456,"botToken":"my_bot_token","offset":1000,"limit":50}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/imbot.v2.Event.get

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

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

try {
            $response = $b24Service
                ->core
                ->call(
                    'imbot.v2.Event.get',
                    [
                        'botId' => 456,
                        'offset' => 1000,
                        '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(
            'imbot.v2.Event.get',
            {
                botId: 456,
                offset: 1000,
                limit: 50,
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error().ex);
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'imbot.v2.Event.get',
            [
                'botId' => 456,
                'offset' => 1000,
                '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": 1001,
                        "type": "ONIMBOTV2MESSAGEADD",
                        "date": "2025-01-15T10:30:00+01:00",
                        "data": {}
                    }
                ],
                "nextOffset": 1002,
                "hasMore": false
            },
            "time": {
                "start": 1728626400.123,
                "finish": 1728626400.234,
                "duration": 0.111,
                "processing": 0.045,
                "date_start": "2024-10-11T10:00:00+01:00",
                "date_finish": "2024-10-11T10:00:00+01: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`	Type of event. 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 descriptions
result.nextOffset `integer`	Value for the next call `offset`. Confirms already processed events and shifts the queue cursor
result.hasMore `boolean`	`true` if there are more unprocessed events
time `time`	Information about the request execution time

Event Types

Type	Description
`ONIMBOTV2MESSAGEADD`	New message to the bot
`ONIMBOTV2MESSAGEUPDATE`	Message edited
`ONIMBOTV2MESSAGEDELETE`	Message deleted
`ONIMBOTV2JOINCHAT`	Bot added to chat
`ONIMBOTV2DELETE`	Bot removed
`ONIMBOTV2CONTEXTGET`	Context of chat call passed
`ONIMBOTV2COMMANDADD`	Slash command invoked
`ONIMBOTV2REACTIONCHANGE`	Reaction changed

Events are addressed to a specific bot—by mentioning @bot or in a private chat. For bots of type personal and supervisor, all events in chats where the bot is present are delivered.

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

Error Handling

HTTP Status: 400, 403

{
            "error": "BOT_NOT_FOUND",
            "error_description": "Bot not found"
        }

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

Possible Error Codes

Code	Description	Value
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` not specified. Required for webhook authorization
`BOT_ID_REQUIRED`	Bot ID is required	`botId` not specified
`BOT_NOT_FOUND`	Bot not found	Bot not found
`BOT_OWNERSHIP_ERROR`	Bot is registered by another application	Bot registered by another application
`SCOPE_ERROR`	Scope error	Missing `im` scope—required when using `withUserEvents: true`
`AUTH_ERROR`	Auth error	Unable to determine the current user
`USER_NOT_SUBSCRIBED`	User not subscribed	User not subscribed to events via im.v2.Event.subscribe

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

Overview of Methods

Event Formats

Get Events from imbot.v2.Event.get

When to Use When to Use imbot.v2.Event.get

Alternative: Webhook ModeAlternative: Webhook Mode

Method ParametersMethod Parameters

Retrieving Bot and User EventsRetrieving Bot and User Events

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Event TypesEvent Types

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning