Initialization and Authorization: Feature 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.

System functions prepare the embedded application for operation. They are used prior to API calls and interface interactions.

The functions in this section work only within the context of the application.

Quick Navigation: All Functions

Getting Started

  1. Wait for the library to be ready via BX24.init to retrieve Bitrix24 data and proceed to the next calls.
  2. Register a handler through BX24.install if a first launch scenario for the current user is needed.
  3. Complete the setup by calling BX24.installFinish to transition to the standard application initialization.
  4. Obtain the current OAuth data via BX24.getAuth or refresh it through BX24.refreshAuth.

Feature Overview

Initialization and First Launch

Function

Description

BX24.init

Adds an event handler for "library ready for use"

BX24.install

Registers a handler for the first launch of the application for the current user

BX24.installFinish

Completes the work of the installer or application setup wizard

Application Authorization

Function

Description

BX24.getAuth

Retrieves the current authorization data via OAuth 2.0

BX24.refreshAuth

Forcefully refreshes the authorization key
Previous
Call Event Handler Deletion Interface
Next
Initialize the Library