Menu Item in Site Settings and LANDING_SETTINGS Page
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
landing
The LANDING_SETTINGS widget adds an application item to the site or page settings menu in edit mode.
Use it when the application works with an entire site or page. For example, when it:
- checks the page meta tags and headings before publishing
- sends the page for external moderation or approval
If the action applies to a single block, use LANDING_BLOCK_ or LANDING_BLOCK_*.
The embedding location is registered with the landing.repo.bind or placement.bind method. Remove it the same way it was registered: with the landing.repo.unbind or placement.unbind method. These methods work only in the application context; the embedding location cannot be registered through a webhook.
The embedding location will not be displayed in the interface until the application installation is complete. Check the application installation
Where the Widget is Embedded
Embedding Location 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. Application items appear at the end of the left slider menu, with newer items above older ones. The item label is the TITLE value from the registration: if it is empty, the item appears without a label, and the application name is not substituted.
Site settings and page settings open in the same slider, so the application has one item for both sections. The item is visible to everyone who opens the settings slider, even without permission to change the settings.
Application items are not displayed in the settings of the Main Page, a site of type VIBE.
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":"12","LID":"30"}
)
Required parameters are marked with *
Parameters in the Handler URL Query String
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
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
type
Description
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
SERVER_ENDPOINT*
string
Address of the Bitrix24 authorization server needed to refresh OAuth 2 tokens
APPLICATION_TOKEN*
string
Application token. The same value is passed in the application_token parameter when event handlers are invoked. The widget handler can use it to verify that the request came from Bitrix24
APPLICATION_SCOPE*
string
List of scopes granted to the application, separated by commas. Shows which REST API methods are available with the authorization token received
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:
L - local application
F - free mass-market application
D - demo version of a mass-market application
T - trial version of a mass-market application, time-limited
P - paid mass-market application
PLACEMENT*
string
The placement code. 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 placement 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 object 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 placement and object the widget handler was invoked
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.
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:
Key
type
Description
SITE_ID
string
Identifier of the site whose settings the widget is opened in
LID
string
Identifier of the page whose editor the settings were opened from. If the settings were opened without reference to a page, 0 is passed
URI
string
Path with the query string of the page from which the widget was opened. If the page address cannot be determined, the key is not passed
The handler retrieves site and page data by the identifiers from PLACEMENT_OPTIONS:
- the site — with the landing.site.getList method filtered by
ID, and its additional fields — with the landing.site.getadditionalfields method
- the page — with the landing.landing.getList method filtered by
ID, and its meta tags and other additional fields — with the landing.landing.getadditionalfields method
If the settings are opened for a Knowledge Base or a group site, pass the scope parameter to these methods, otherwise they will not find the site. The values are described in Working with Site Types and Scopes.
Code Examples
How to Use Examples in Documentation
cURL (OAuth)
JS (TS)
JS (UMD)
Python
PHP
BX24.js
PHP CRest
Go
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"PLACEMENT": "LANDING_SETTINGS",
"PLACEMENT_HANDLER": "https://your-domain.com/widgets/landing-settings-handler.php",
"TITLE": "My settings",
}
try:
bitrix_response = client.landing.repo.bind(fields=fields).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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();
echo 'Success: ' . var_export($result, 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. On success, result = true.
// The response shape is described on the landing.repo.bind method page.
fmt.Printf("%s\n", res.Result)
Continue Learning
- Embedding Locations in the Sites Section: Overview of Methods
- Register an Embedding Location landing.repo.bind
- Remove Embedding Placement landing.repo.unbind
- Get Additional Fields of the Page landing.landing.getadditionalfields
- Get Additional Fields of the Site landing.site.getadditionalfields
- Block Editing Item LANDING_BLOCK_<CODE> and LANDING_BLOCK_*
- Methods of BX24 SDK for Widgets