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 |
|
|
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 sent in a POST request: some parameters come in the handler URL query string, the rest in the request body
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 *
Parameters in the Handler URL Query String
|
Parameter |
Description |
|
DOMAIN* |
The Bitrix24 address where the widget handler was invoked |
|
PROTOCOL* |
Secure or non-secure HTTP protocol:
|
|
LANG* |
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* |
Application session identifier. Bitrix24 generates a new one each time the widget is rendered and uses it to link the js library with the application environment |
Parameters in the POST Request Body
|
Parameter |
Description |
|
AUTH_ID |
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 |
Time in seconds after which the authorization token will become invalid |
|
REFRESH_ID |
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 |
|
SERVER_ENDPOINT* |
Address of the Bitrix24 authorization server needed to refresh OAuth 2 tokens |
|
APPLICATION_TOKEN* |
Application token. The same value is passed in the |
|
APPLICATION_SCOPE* |
List of scopes granted to the application, separated by commas. Shows which REST API methods are available with the authorization token received |
|
member_id* |
Unique string identifier of Bitrix24 where the widget handler was invoked. |
|
status |
Type of application that registered the handler for this widget. Accepts values:
|
|
PLACEMENT* |
The placement code. You can use the same handler URL for all your widgets. The value that Bitrix24 will report in the |
|
PLACEMENT_OPTIONS |
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 object in the detail form where the widget handler was invoked, etc. The |
Bitrix24 adds a URI key to PLACEMENT_OPTIONS — the path with the query string of the page from which the widget was opened. It arrives for any placement, along with the keys of that placement itself. The key is absent if the browser did not send the Referer header or if the widget was opened from a page on a different domain.
How to Parse the Call Context
PLACEMENT_OPTIONS arrives as a JSON string, not as an array: parse it on the handler side before use. The set of keys is specific to each placement and is described in the PLACEMENT_OPTIONS section of this page.
$placement = $_POST['PLACEMENT'] ?? '';
$options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);
options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")
In B24JsSDK, there is no need to parse the string: the $b24.placement.options property returns a ready object, and $b24.placement.placement returns the placement code.
What the Handler Must Return
The handler responds with a regular HTML page — Bitrix24 displays it in a frame in place of the widget. The page must allow embedding: if the application server sends the X-Frame-Options or Content-Security-Policy headers that prohibit framing, an empty area remains in place of the widget. How to fix it is described in the article Site Does Not Allow Connection.
Additional Data
|
Parameter |
Description |
|
APPLICATION_SCOPE |
List of scopes available to the application |
|
APPLICATION_TOKEN |
Application token for secure event handling |
|
SERVER_ENDPOINT |
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 openedLID— 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'landing.repo.bind',
params: {
fields: {
PLACEMENT: 'LANDING_SETTINGS',
PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
TITLE: 'My Settings',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Landing settings bound:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function bindLandingSettings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'landing.repo.bind',
params: {
fields: {
PLACEMENT: 'LANDING_SETTINGS',
PLACEMENT_HANDLER: 'https://your-domain.com/widgets/landing-settings-handler.php',
TITLE: 'My Settings',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Landing settings bound:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', bindLandingSettings)
</script>
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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "landing.repo.bind", b24.Params{
"fields": b24.Params{
"PLACEMENT": "LANDING_SETTINGS",
"PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-settings-handler.php",
"TITLE": "My Settings",
},
})
if err != nil {
return fmt.Errorf("landing.repo.bind: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)