Local Applications

A local application is created and configured on a specific Bitrix24 — it works only there and cannot be installed on another Bitrix24. An application can show its own page in the interface, exchange data with an external system, or receive Bitrix24 events — the set of capabilities depends on the type.

Applications are divided into static and server-side ones by where the code runs. Server-side applications differ in whether they have an interface, so there are three options:

• static — the code runs in the browser, no server of your own is needed
• server-side with an interface — the code runs on your server, and the application shows a page inside Bitrix24
• server-side without an interface — the code runs on your server, and the application does not appear in the Bitrix24 interface

This page helps you choose the type of application and create it on your own Bitrix24. The development process and a sample walkthrough for each type are described on its own page.

Quick links: How to Choose the Application Type

User documentation: Create Webhooks and Apps in Bitrix24

Connection with Other ObjectsConnection with Other Objects

Developer resources. Local applications are created and found in the Applications > Developer resources section. What else the section holds is described in the Developer resources in Bitrix24 article.

OAuth 2.0. A server-side application accesses the REST API on behalf of an employee over the OAuth 2.0 protocol. How to retrieve and refresh tokens is described in the Complete OAuth 2.0 Authorization Protocol article.

Events and widgets. A server-side application subscribes to events and adds widgets to the Bitrix24 interface.

How to Get StartedHow to Get Started

1. Check the conditions. A local application works only if Bitrix24 has access to the REST API. The application can be created by a Bitrix24 administrator or by an employee who has been granted the permission to create applications.

2. Decide whether the application needs an interface inside Bitrix24 and a server of its own. This determines the type of application — select it in the How to Choose the Application Type table.

3. Prepare the code: for a static application, an archive with a page in HTML and JS; for a server-side one, a page or a handler available over HTTPS before you add the application to Bitrix24.

4. Open the local application form: Applications > Developer resources, the Common use cases tab, then Other > Local application.

5. Fill in the form: the name, the access permissions, and the fields of the selected type — the archive with the page, the handler address, or the initial installation address.

6. Save the application. It will appear in the Applications > Developer resources > Integrations list.

7. Enable the Application uses API only option if the application needs no interface, and store the application code and the secret key in the code on your server — Bitrix24 shows them after the form is saved.

If the Local application item is missing, the permission to create applications is disabled. Ask the administrator to configure access to application creation.

How to Configure Access to Application Creation for EmployeesHow to Configure Access to Application Creation for Employees

An employee without administrator permissions cannot grant this access to themselves. An administrator can allow application creation for all employees or selected users.

1. Open Settings > Bitrix24 settings. The section is available only to employees with administrator permissions.
2. In the new window, go to Security > Bitrix24 integrations.
3. Configure permissions:
   • in the Who can create apps for everyone field, click Add and select all employees or selected users
   • in the Who can create their own apps field, click Add and select all employees or selected users

What to Keep in MindWhat to Keep in Mind

• Authorization. A static application runs inside the Bitrix24 interface, and the JS SDK retrieves the authorization of the employee who opened it automatically. A server-side application with an interface uses a simplified variant of OAuth 2.0: the application acts on behalf of the employee who opened it, and Bitrix24 passes the tokens to the application page in a POST request — there is no need to request them separately. A server-side application without an interface implements the full OAuth 2.0 protocol: it retains the tokens itself in the ONAPPINSTALL event handler and refreshes them itself.
• Secrets. Keep the application code, the secret key, and the tokens obtained with them on your server. Do not place them in client-side code that loads in the browser, and do not retain them in a repository.
• Permissions. The set of application permissions — scope — is selected at creation time. The application works within the selected scope and the permissions of the employee who created it: a method returns an error if the required scope is missing or the employee has no permissions for the object. The permission codes are listed in the Available Scopes in Bitrix24 article.
• Events. A static application does not receive events: it has no server-side handler Bitrix24 could pass them to. If the application has to react to data changes, choose a server-side one or an outbound webhook.

How to Choose the Application TypeHow to Choose the Application Type

If You Need To	Open
Show your own page inside Bitrix24 without a server of your own	Static Local Application
Show your own page inside Bitrix24 and run the code on your server	Server-Side Local Application with User Interface
Work in the background without an interface: data synchronization and event handling	Server-Side Local Application Without a User Interface

Continue Your ExplorationContinue Your Exploration

• Developer resources in Bitrix24
• Inbound and Outbound Webhooks
• Local Integrations: Use Case Scenarios
• Overview of Installing Local Applications