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 can receive events for a specific bot — the one that registered it. If you need multiple independent agents, register a separate bot for each.

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

The method is suitable if:

The bot does not have a public URL for incoming HTTP requests.
Events need to be retrieved by a single background agent (worker) on a schedule.
Explicit control over the event queue is required through offset and nextOffset.
You need to receive bot events ONIMBOTV2* and user events ONIMV2* in a single thread 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 the 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 bot events ONIMBOTV2* and user events ONIMV2* in a single response.

Requirements:

The application must have the scope im 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)

Python

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);
        }

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imbot.v2.event.get(
                bot_id=456,
                offset=1000,
                limit=50,
                with_user_events=True,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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";
            }
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.v2.Event.get", b24.Params{
        	"botId":          456,
        	"botToken":       "my_bot_token",
        	"offset":         1000,
        	"limit":          50,
        	"withUserEvents": true,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imbot.v2.Event.get: %w", err)
        }
        
        var item struct {
        	NextOffset int  `json:"nextOffset"`
        	HasMore    bool `json:"hasMore"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.NextOffset, item.HasMore)

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

Python

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);
        }

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.imbot.v2.event.get(
                bot_id=456,
                bot_token="my_bot_token",
                offset=1000,
                limit=50,
            ).response
            result = bitrix_response.result
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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";
            }
        }

// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "imbot.v2.Event.get", b24.Params{
        	"botId":    456,
        	"botToken": "my_bot_token",
        	"offset":   1000,
        	"limit":    50,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("imbot.v2.Event.get: %w", err)
        }
        
        var item struct {
        	NextOffset int  `json:"nextOffset"`
        	HasMore    bool `json:"hasMore"`
        }
        if err := json.Unmarshal(res.Result, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.NextOffset, item.HasMore)

Response Handling

HTTP Status: 200

{
            "result": {
                "events": [
                    {
                        "eventId": 1001,
                        "type": "ONIMBOTV2MESSAGEADD",
                        "date": "2025-01-15T10:30:00+02: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+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`	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 the 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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only `error_description` shows the reason
error_description `string`	Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code	Description	Value
`BOT_TOKEN_NOT_SPECIFIED`	Bot token is not specified	`botToken` not provided. Required for webhook authorization
`BOT_ID_REQUIRED`	Bot ID is required	`botId` not provided
`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 scope `im` — required when using `withUserEvents: true`
`AUTH_ERROR`	Auth error	Failed 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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	The REST API is available only on commercial plans. A webhook receives a different error message — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open it 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

Was the article helpful?

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