General Methods and Events: Overview
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.
General methods and events help verify the application context, retrieve data about the current user, save integration settings, and manage the application lifecycle.
No separate scopes are needed for the methods in this section. Additional restrictions depend on the application context and the access permissions of the current user.
Quick navigation: all methods and events
How to Choose a Group of Methods
|
If you need |
Open the group of methods |
|
Check the availability of a method, application scope, |
|
|
Retrieve the profile of the current user and check their permissions |
|
|
Save general or personal application settings |
|
|
Respond to installation, updates, deletion, and payment of the application |
What to Consider Before Getting Started
Application Context. The methods app.*, user.option.*, events in this section, and some system methods work only within the context of the application. This is important to consider before the first call.
Availability Check. Before calling a method, check its availability via method.get, and obtain the list of scopes through scope.
Access Codes. To verify the permissions of the current user, use user.access. Decoding ACCESS codes can be assisted by access.name.
Application Settings. Store general integration parameters through app.option.*, and personal user settings through user.option.*.
Connection with Other Objects
This section is connected with the application, the current user, and access permissions.
Application. The methods app.info, app.option.get, and app.option.set work with the data and settings of the current application.
User. The method profile retrieves the ID, first name, last name, and other data of the current user. The methods user.admin and user.access check their permissions before calling methods with restrictions.
Permissions. The method scope returns the scope of the current application. The values of the scope codes are described on the available scopes page.
Overview of Methods and Events
Scope:
basicWho can execute the method: depends on the method
|
Method |
Description |
|
Checks the existence of a method in Bitrix24 and the availability of a call for the application |
|
|
Retrieves the list of scopes available to the current application |
|
|
Returns information about the application |
|
|
Retrieves the names of the |
|
|
Checks the availability of functionality in Bitrix24 |
|
|
Returns the current server time |
|
|
Checks if the current user can manage application settings |
|
|
Checks if the current user has at least one of the specified access codes ( |
|
|
Retrieves information about the current user |
|
|
Saves general application settings |
|
|
Retrieves general application settings |
|
|
Saves the current user's settings for the application |
|
|
Retrieves the current user's settings for the application |
|
Event |
Triggered |
|
Upon successful installation of the application |
|
|
Upon updating the application |
|
|
Upon uninstalling the application |
|
|
Upon receiving an administrator's decision on a request to use methods requiring confirmation |
|
|
Upon payment for the application |
|
|
Upon adding a user to Bitrix24 |