Overview of Installing Local Applications
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.
A local application operates within a single Bitrix24 instance—the one where it was created. It can display reports, exchange data with an external system, or add its own interface items.
After saving, the application is added to Bitrix24, and further installation depends on the selected scenario. Choose a scenario before saving:
- Make the application immediately available to users
- Show the initial setup page to the administrator first
- Pass authorization data to the application server
Quick links: How to Choose a Scenario
User documentation: Create webhooks and apps in Bitrix24
Connection with Other Objects
OAuth 2.0. Bitrix24 passes authorization data to the application, which it uses to execute methods. Retrieving and refreshing tokens is described in the OAuth 2.0 section.
Events and Widgets. During initial setup, an application can register event handlers or add widgets to the Bitrix24 interface.
Getting Started
- Determine whether the application requires an interface within Bitrix24
- Prepare the application page, server handler, or a ZIP archive containing static files
- Select an option from the How to Choose a Scenario table
- Open the local application form following the user instructions
- Specify a name, select permissions, and fill in the fields for the chosen scenario
- Save the application and perform the initial setup if required
How to Choose a Scenario
|
If necessary |
Open |
|
Make the application immediately available to users |
Server-side local application with a user interface or Static local application |
|
Configure the application first |
|
|
Pass authorization data to the application server |