Events: Overview of Methods
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.
This section describes the methods for subscribing to user events from the messenger and retrieving them in polling mode. Use these methods if the integration needs to read the stream of events on behalf of a user or application.
Quick navigation: all methods
How to Work with Events
- Enable event recording via im.v2.Event.subscribe.
- Retrieve accumulated events through im.v2.Event.get.
- Pass
offsetto confirm already processed records. - Terminate the subscription using the im.v2.Event.unsubscribe method.
What is polling mode
Polling is a mode of receiving events where the application periodically requests accumulated events from the server. The server does not know the application's address and does not send anything on its own—it only accumulates a queue and delivers it upon request.
This distinguishes polling from webhook: in webhook mode, Bitrix24 calls the application's URL for each new event. Polling is convenient if the application does not have a permanent HTTP server or a public URL.
Overview of Methods
Scope:
imWho can execute the methods: a user or an application with access to the messenger
|
Method |
Description |
|
Subscribes to event recording |
|
|
Stops event recording |
|
|
Returns events in polling mode |
|
|
Description of events and data structures |