Overview of Events When Working with the Application

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.

Events allow applications to respond to changes in near real-time: receiving notifications about installation, updates, deletions, and payments of the application, adding users, and the administrator's decision regarding requests for access to methods requiring confirmation.

Detailed information on working with events is described in the article Concept and Benefits of Event Processing.

Quick navigation: all events

The events section works only in the context of the application.

How to Receive Events

You can subscribe to application events through the application and the event.bind method.

To receive events:

  • install the application and specify the public URL of the handler
  • if the application requests access to methods requiring confirmation, handle the onAppMethodConfirm event

An example of a handler code for the event is described in the article How to Test Your Handler for Processing Bitrix24 Events.

Server Availability for Sending and Receiving Events

The event handler server must be accessible from the outside. To configure the accessibility of the event handler server and application, refer to the article Required network access.

For cloud Bitrix24, no additional configuration is required. For on-premise Bitrix24, configure accessibility on the server or hosting according to the article Required network access.

Interaction with Other Objects

User. Data from the onAppUserAdd event can be used together with the user.get method if additional information about the user is needed after registration or to configure access.

Overview of Events

Scope: basic

Who can subscribe: any user

Event

Description

onAppInstall

When the application is successfully installed

onAppUpdate

When the application is updated

onAppUninstall

When the application is uninstalled

onAppMethodConfirm

When receiving the administrator's decision regarding a request for access to methods requiring confirmation

onAppPayment

When the application is paid for

onAppUserAdd

When a user is added to Bitrix24