Editing the LANDING_BLOCK_* Integration Point

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: landing

The widget LANDING_BLOCK_<CODE> adds an application item next to the block editing actions in the page editor.

For integration within the landing section, the internal method of the landing.repo.bind module is used instead of placement.bind.

The integration code depends on the block code and is specified in the format LANDING_BLOCK_<CODE>.

If you need to integrate the application into a custom block registered by you, specify the block identifier instead of <CODE>. For example, for a block with the identifier 1132, use the code LANDING_BLOCK_repo_1132. The case of the characters in the code is not important.

The integration will not be displayed in the interface until the application installation is complete. Check the application installation

Where the Widget is Integrated

Integration Code

Location

LANDING_BLOCK_<CODE>

Edit item for a specific block

LANDING_BLOCK_*

Edit item for all blocks

Where to Find It in the Interface

Open the page in edit mode and hover over the block. In the standard block actions, to the right of the Edit button, there is a More button. The application item with PLACEMENT=LANDING_BLOCK_<CODE> or PLACEMENT=LANDING_BLOCK_* appears in the dropdown list of the More button.

What the Handler Receives

Data is transmitted as a POST request

Array
        (
            [DOMAIN] => example.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => de
            [APP_SID] => 0123456789abcdef0123456789abcdef
            [APPLICATION_SCOPE] => crm,placement,landing
            [APPLICATION_TOKEN] => xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
            [AUTH_ID] => 6061e72600631fcd00005a4b00000001f0f1076700000000f69dd5fc643d9ce2fdbc1
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 50e00aa340631fcd00005a4b00000001f0f1071111116580a5b83c2de639ef28c12
            [SERVER_ENDPOINT] => https://oauth.bitrix24.info/rest/
            [member_id] => abcdef1234567890abcdef1234567890
            [status] => F
            [PLACEMENT] => LANDING_BLOCK_*
            [PLACEMENT_OPTIONS] => {"ID":"996","CODE":"43.4.cover_with_price_text_button_bgimg","LID":"30"}
        )

Required parameters are marked with *

Parameter
type

Description

DOMAIN*
string

The Bitrix24 address where the widget handler was invoked

PROTOCOL*
string

Secure or non-secure HTTP protocol:

  • 0 - HTTP
  • 1 - HTTPS

LANG*
string

The user interface language of Bitrix24 that invoked the widget. You can localize the interface language in your widget based on this value

APP_SID
string

String identifier of the application that registered the widget handler

AUTH_ID
string

Authorization token OAuth 2 issued for the user who invoked the widget. Can be used for REST API calls on behalf of this user

AUTH_EXPIRES
integer

Time in seconds after which the authorization token will become invalid

REFRESH_ID
string

Refresh token OAuth 2 issued for the user who invoked the widget. Can be used to refresh the authorization token on behalf of this user

member_id*
string

Unique string identifier of Bitrix24 where the widget handler was invoked.

status
string

Type of application that registered the handler for this widget. Accepts values:

PLACEMENT*
string

Code for the widget embedding location. You can use the same handler URL for all your widgets. The value that Bitrix24 will report in the PLACEMENT parameter will help determine from which specific widget embedding location your handler was invoked in each case

PLACEMENT_OPTIONS
string

Additional data in the form of a JSON string that defines the context of the widget execution. For example, this could be an array containing the numeric identifier of the CRM entity in the detail form where the widget handler was invoked, etc. The PLACEMENT_OPTIONS parameter, along with the PLACEMENT parameter, allows you to accurately determine for which specific widget embedding location and object the widget handler was invoked.

Additional Data

Parameter type

Description

APPLICATION_SCOPE string

List of scopes available to the application

APPLICATION_TOKEN string

Application token for secure event handling

SERVER_ENDPOINT string

Bitrix24 authorization server address needed for updating OAuth 2.0 tokens

PLACEMENT_OPTIONS

The value of PLACEMENT_OPTIONS is passed as a JSON string with the context of the call.

For LANDING_BLOCK_<CODE>, the following keys are passed in the context:

  • ID — block identifier
  • CODE — symbolic code of the block
  • LID — identifier of the page where the block is opened

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "PLACEMENT": "LANDING_BLOCK_04.1.one_col_fix_with_title",
              "PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-block-handler.php",
              "TITLE": "My Widget for the Block"
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/landing.repo.bind
        
try
        {
            const response = await $b24.callMethod(
                'landing.repo.bind',
                {
                    fields: {
                        PLACEMENT: 'LANDING_BLOCK_04.1.one_col_fix_with_title',
                        PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-block-handler.php',
                        TITLE: 'My Widget for the Block'
                    }
                }
            );
        
            const result = response.getData().result;
            if (result.error())
                console.error(result.error());
            else
                console.info(result.data());
        }
        catch (error)
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.repo.bind',
                    [
                        'fields' => [
                            'PLACEMENT' => 'LANDING_BLOCK_04.1.one_col_fix_with_title',
                            'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-block-handler.php',
                            'TITLE' => 'My Widget for the Block',
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding landing block: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.repo.bind',
            {
                fields: {
                    PLACEMENT: 'LANDING_BLOCK_04.1.one_col_fix_with_title',
                    PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-block-handler.php',
                    TITLE: 'My Widget for the Block'
                }
            },
            function(result)
            {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.repo.bind',
            [
                'fields' => [
                    'PLACEMENT' => 'LANDING_BLOCK_04.1.one_col_fix_with_title',
                    'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-block-handler.php',
                    'TITLE' => 'My Widget for the Block',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Registering a Widget for All Blocks

If the application needs a single handler for all blocks, use the code LANDING_BLOCK_*.

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "PLACEMENT": "LANDING_BLOCK_*",
              "PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-block-handler.php",
              "TITLE": "My Widget for the Block"
            },
            "auth": "**put_access_token_here**"
          }' \
          https://**put_your_bitrix24_address**/rest/landing.repo.bind
        
try
        {
            const response = await $b24.callMethod(
                'landing.repo.bind',
                {
                    fields: {
                        PLACEMENT: 'LANDING_BLOCK_*',
                        PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-block-handler.php',
                        TITLE: 'My Widget for the Block'
                    }
                }
            );
        
            const result = response.getData().result;
            if (result.error())
                console.error(result.error());
            else
                console.info(result.data());
        }
        catch (error)
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.repo.bind',
                    [
                        'fields' => [
                            'PLACEMENT' => 'LANDING_BLOCK_*',
                            'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-block-handler.php',
                            'TITLE' => 'My Widget for the Block',
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding landing block: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.repo.bind',
            {
                fields: {
                    PLACEMENT: 'LANDING_BLOCK_*',
                    PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-block-handler.php',
                    TITLE: 'My Widget for the Block'
                }
            },
            function(result)
            {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'landing.repo.bind',
            [
                'fields' => [
                    'PLACEMENT' => 'LANDING_BLOCK_*',
                    'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-block-handler.php',
                    'TITLE' => 'My Widget for the Block',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

How to Update a Block from the Application

After working with the block, the application can update it using the refreshBlock command of the BX24.placement.call method.

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"PLACEMENT":"refreshBlock","PARAMS":{"id":123}}' \
          "https://**put_your_bitrix24_address**/rest/placement.call?auth=**put_access_token_here**"
        
try
        {
            await $b24.callMethod(
                'placement.call',
                {
                    type: 'refreshBlock',
                    params: {
                        id: 123
                    }
                }
            );
        
            console.log('Block successfully updated');
        }
        catch (error)
        {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.call',
                    [
                        'PLACEMENT' => 'refreshBlock',
                        'PARAMS' => [
                            'id' => 123,
                        ]
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
            echo 'Success: ' . print_r($result, true);
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating block: ' . $e->getMessage();
        }
        
BX24.placement.call(
            'refreshBlock',
            {
                id: 123
            },
            function()
            {
                console.log('Block successfully updated');
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.call',
            [
                'PLACEMENT' => 'refreshBlock',
                'PARAMS' => [
                    'id' => 123,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Continue Learning

Previous
Settings Menu Item
Next
Remove Embedding Locations