Get Information About the JS Interface of the Current Placement BX24.placement.getInterface

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.

Scope: placement

The method BX24.placement.getInterface allows you to retrieve information about the JS interface of the current placement: a list of available commands and events.

Parameters

Required parameters are marked with *

Name
type

Description

callback*
callable

Callback function.

The callback handler will receive an object of the form {command: array, event: array}, where:

  • command — list of available commands
  • event — list of available events

For example: the placement CALL_CARD is intended for working with the call card in the CRM

Code Example

How to Use Examples in Documentation

BX24.ready(function () {
            BX24.init(function () {
                BX24.placement.getInterface((result) => {
                    console.info(result);
                });
            });
        });

Result

{"command":["getStatus", "disableAutoClose", "enableAutoClose" …],"event":[{"CallCard::EntityChanged", "CallCard::CallStateChanged", "CallCard::BeforeClose" …}]}

Continue Your Learning

Previous
Get Execution Context
Next
Call Widget Method