Embedding Locations in the Sites Section: Overview of Methods

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.

Embedding locations allow you to add an application to the interface of the "Sites" section. They define where in the interface the user will see the application or be able to invoke its action.

For example, an application can be added to the page settings to open it from the editor. Another option is to display an action in the block menu, allowing users to work with a specific block without navigating to another section.

Quick navigation: all methods

How to Work with Embedding Locations

In the "Sites" section, there are three main embedding options. Each uses its own embedding locations and methods.

Site or Page Settings. Use LANDING_SETTINGS if the application needs to open from the site or page settings. For instance, you can add an item in the page settings to check meta tags or to send the page for external moderation.

To configure:

Select the embedding location LANDING_SETTINGS.
Register the embedding location using the internal method landing.repo.bind, not placement.bind.
In the handler, parse PLACEMENT_OPTIONS to obtain the site and page identifiers.
If the embedding location is no longer needed, it can be removed using the method landing.repo.unbind.

Actions with a Block. Use LANDING_BLOCK_* if the action needs to be available while editing a block. This option is suitable when the application works not with the entire page but with a specific block. For example, you can add an action for a text block that opens the translation interface, or an action for an image block that initiates a link check for a file.

To configure:

Select LANDING_BLOCK_<CODE> if the action is needed only for one type of block, or LANDING_BLOCK_* if the action should work for all blocks.
Register the embedding location using the internal method landing.repo.bind, not placement.bind.
In the handler, parse PLACEMENT_OPTIONS to obtain the page, block, and block code identifiers.
If the embedding location is no longer needed, it can be removed using the method landing.repo.unbind.

Linking the Knowledge Base to a Menu or Group. Use the subsection Embedding the Knowledge Base if you need to display the Knowledge Base in a menu or link it to a group.

This option differs from other scenarios. Here, the internal method landing.repo.bind and placement.bind are not used; instead, separate binding methods are employed. This is because the Knowledge Base in the landing module is represented as a separate site.

To configure:

Obtain the Knowledge Base site identifier, for example, using the method landing.site.getList.
Determine where to add the Knowledge Base: in the menu or to a group.
For the menu, use the methods landing.site.bindingToMenu, landing.site.getMenuBindings, landing.site.unbindingFromMenu.
For the group, use the methods landing.site.bindingToGroup, landing.site.getGroupBindings, landing.site.unbindingFromGroup.

Relationships with Other Sections

Sites and Pages. The embedding location LANDING_SETTINGS works in the editor for sites and pages. Therefore, the site and page identifiers are passed to the handler.

Blocks. The embedding location LANDING_BLOCK_* is associated with a specific block on the page. The block code, block identifier, and page identifier are used when working with the methods in the Blocks and Working with Blocks on the Page sections.

Widgets. The general mechanics of embedding interfaces are described in the Widgets section, but for the landing module, registration is performed using the internal method landing.repo.bind, not placement.bind.

Knowledge Base. Knowledge Base bindings use the methods of the Site object because the Knowledge Base is represented as a separate site in the landing module.

Overview of Embedding Locations and Methods

Scope: landing

Who can execute the method: depends on the method