Menu Item in Site Settings and LANDING_SETTINGS Page

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 LANDING_SETTINGS widget adds an application item to the site or page settings menu in edit mode.

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

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

Where the Widget is Embedded

Widget Code

Location

LANDING_SETTINGS

Item in the site or page settings menu

Where to Find It in the Interface

Open the site or page in edit mode. In the upper right corner, go to Site Capabilities > Settings (⚙️). The application item with PLACEMENT=LANDING_SETTINGS appears as the last item in the left slider menu.

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_SETTINGS
            [PLACEMENT_OPTIONS] => {"SITE_ID":"30","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_SETTINGS, the following keys are passed in the context:

  • SITE_ID — the identifier of the site where the widget is opened
  • LID — the identifier of the page from which the widget was called in edit mode

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "fields": {
              "PLACEMENT": "LANDING_SETTINGS",
              "PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-settings-handler.php",
              "TITLE": "My Settings"
            },
            "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_SETTINGS',
                        PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
                        TITLE: 'My Settings'
                    }
                }
            );
        
            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_SETTINGS',
                            'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-settings-handler.php',
                            'TITLE' => 'My Settings',
                        ],
                    ]
                );
        
            $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 settings: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.repo.bind',
            {
                fields: {
                    PLACEMENT: 'LANDING_SETTINGS',
                    PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
                    TITLE: 'My Settings'
                }
            },
            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_SETTINGS',
                    'PLACEMENT_HANDLER' => 'https://your-domain.com/widgets/landing-settings-handler.php',
                    'TITLE' => 'My Settings',
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Continue Learning

Previous
Overview of Methods
Next
Block Editing Item