Open Path in the BX24.openPath Slider

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

The method BX24.openPath opens the specified path within Bitrix24 in a slider.

void BX24.openPath(String path[, Function callback])

For security reasons, this method does not work in the mobile application.

Parameters

Required parameters are marked with *

Name
type

Description

path*
string

The path within Bitrix24. It starts with / and leads to a page of the same Bitrix24 where the application is open. The method does not open external addresses or paths to other domains.

The numbers in the path are identifiers of specific objects. Substitute your own values for them:

  • /crm/deal/details/5/ — a deal detail form, where 5 is the deal identifier
  • /crm/lead/details/12/ — a lead detail form, where 12 is the lead identifier
  • /crm/contact/details/2/ — a contact detail form, where 2 is the contact identifier
  • /crm/company/details/7/ — a company detail form, where 7 is the company identifier
  • /crm/type/128/details/3/ — a smart process item detail form, where 128 is the smart process type identifier entityTypeId, and 3 is the identifier of the item itself
  • /company/personal/user/1/ — an employee profile, where 1 is the user identifier
  • /workgroups/group/4/ — a workgroup or project, where 4 is the group identifier
  • /marketplace/ — Marketplace, no identifier required

callback
function

Callback function. Invoked when there is an error opening the path or when the slider is closed

To retrieve CRM object identifiers, use the list and creation methods, for example crm.item.list and crm.item.add. To retrieve an employee identifier, use user.get, and for a workgroup identifier use sonet_group.get.

Before opening, the SDK automatically adds service parameters to the path:
from=rest_placement&from_app={appId}.

Code Example

BX24.init(function () {
            BX24.openPath('/crm/deal/details/5/', function (result) {
                console.log(result);
            });
        });

How to Use Examples in Documentation

Response Handling

The method does not return data (void).

If a callback is provided, it receives a result object.

Callback Result

Name
type

Description

result
string

Execution status: close or error

errorCode
string

Error code. Passed only when result: "error". Possible values: PATH_NOT_AVAILABLE, METHOD_NOT_SUPPORTED_ON_DEVICE

Continue Learning

Previous
Run JavaScript File
Next
Call via Internal Communication