Register a Widget Handler placement.bind
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:
placement,depending on the placementWho can execute the method: administrator
The method placement.bind adds a handler for the widget placement.
It can be called at any time during the application's operation; however, it is often more convenient to register your widgets during the application installation.
Until the application installation is complete, the registered widgets are not displayed in the Bitrix24 interface — neither to regular users nor to administrators.
Check the application installation.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
PLACEMENT* |
Code of the placement |
|
HANDLER* |
URL of the widget handler |
|
TITLE |
Name of the widget in the interface. Depending on the placement, this may be the name of a tab in a form, a menu item, etc. |
|
DESCRIPTION |
Description of the widget in the interface. Not used in practice |
|
GROUP_NAME |
Allows grouping UI elements for multiple handlers of the same widget type. For example, several dropdown items in the top button of the CRM card. Supported only by certain types of widgets |
|
LANG_ALL |
Array of parameters
|
|
OPTIONS |
Additional display parameters for the widget. Specific values depend on the placement. Currently used in widgets for messengers, in the widget |
|
USER_ID |
Identifier of the Bitrix24 user for whom the registered widget will be available. Possible values can be obtained using the user.get method. Currently, this parameter is only supported by the widget If you attempt to register a placement in other widgets, you will receive the error |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"PLACEMENT":"PLACEMENT_CODE","HANDLER":"http://myapp.com/handler/?type=1","OPTIONS":{"errorHandlerUrl":"http://myapp.com/error/"},"TITLE":"title","DESCRIPTION":"description","GROUP_NAME":"group","LANG_ALL":{"en":{"TITLE":"title","DESCRIPTION":"description","GROUP_NAME":"group"},"de":{"TITLE":"Titel","DESCRIPTION":"Beschreibung","GROUP_NAME":"Gruppe"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/placement.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: 'placement.bind',
params: {
PLACEMENT: 'PLACEMENT_CODE',
HANDLER: 'http://myapp.com/handler/?type=1',
OPTIONS: {
errorHandlerUrl: 'http://myapp.com/error/',
},
TITLE: 'title',
DESCRIPTION: 'description',
GROUP_NAME: 'group',
LANG_ALL: {
en: {
TITLE: 'title',
DESCRIPTION: 'description',
GROUP_NAME: 'group',
},
ru: {
TITLE: 'title',
DESCRIPTION: 'description',
GROUP_NAME: 'group',
},
},
},
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('Handler registered:', 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 bindPlacement() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'placement.bind',
params: {
PLACEMENT: 'PLACEMENT_CODE',
HANDLER: 'http://myapp.com/handler/?type=1',
OPTIONS: {
errorHandlerUrl: 'http://myapp.com/error/',
},
TITLE: 'title',
DESCRIPTION: 'description',
GROUP_NAME: 'group',
LANG_ALL: {
en: {
TITLE: 'title',
DESCRIPTION: 'description',
GROUP_NAME: 'group',
},
ru: {
TITLE: 'title',
DESCRIPTION: 'description',
GROUP_NAME: 'group',
},
},
},
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('Handler registered:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', bindPlacement)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.placement.bind(
placement="PLACEMENT_CODE",
handler="http://myapp.com/handler/?type=1",
options={
"errorHandlerUrl": "http://myapp.com/error/",
},
title="title",
description="description",
group_name="group",
lang_all={
"en": {
"TITLE": "title",
"DESCRIPTION": "description",
"GROUP_NAME": "group",
},
"ru": {
"TITLE": "title",
"DESCRIPTION": "description",
"GROUP_NAME": "group",
},
},
).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(
'placement.bind',
[
'PLACEMENT' => 'PLACEMENT_CODE',
'HANDLER' => 'http://myapp.com/handler/?type=1',
'OPTIONS' => [
'errorHandlerUrl' => 'http://myapp.com/error/'
],
'TITLE' => 'title',
'DESCRIPTION' => 'description',
'GROUP_NAME' => 'group',
'LANG_ALL' => [
'en' => [
'TITLE' => 'title',
'DESCRIPTION' => 'description',
'GROUP_NAME' => 'group',
],
'de' => [
'TITLE' => 'Titel',
'DESCRIPTION' => 'Beschreibung',
'GROUP_NAME' => 'Gruppe',
]
]
]
);
$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 placement: ' . $e->getMessage();
}
BX24.callMethod(
"placement.bind",
{
"PLACEMENT": "PLACEMENT_CODE",
"HANDLER": "http://myapp.com/handler/?type=1",
"OPTIONS": {
"errorHandlerUrl": "http://myapp.com/error/"
},
"TITLE": "title",
"DESCRIPTION": "description",
"GROUP_NAME": "group",
"LANG_ALL": {
"en": {
"TITLE": "title",
"DESCRIPTION": "description",
"GROUP_NAME": "group",
},
"de": {
"TITLE": "Titel",
"DESCRIPTION": "Beschreibung",
"GROUP_NAME": "Gruppe",
}
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'placement.bind',
[
'PLACEMENT' => 'PLACEMENT_CODE',
'HANDLER' => 'http://myapp.com/handler/?type=1',
'OPTIONS' => [
'errorHandlerUrl' => 'http://myapp.com/error/'
],
'TITLE' => 'title',
'DESCRIPTION' => 'description',
'GROUP_NAME' => 'group',
'LANG_ALL' => [
'en' => [
'TITLE' => 'title',
'DESCRIPTION' => 'description',
'GROUP_NAME' => 'group'
],
'de' => [
'TITLE' => 'Titel',
'DESCRIPTION' => 'Beschreibung',
'GROUP_NAME' => 'Gruppe'
]
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "placement.bind", b24.Params{
"PLACEMENT": "PLACEMENT_CODE",
"HANDLER": "http://myapp.com/handler/?type=1",
"OPTIONS": b24.Params{
"errorHandlerUrl": "http://myapp.com/error/",
},
"TITLE": "title",
"DESCRIPTION": "description",
"GROUP_NAME": "group",
"LANG_ALL": b24.Params{
"en": b24.Params{
"TITLE": "title",
"DESCRIPTION": "description",
"GROUP_NAME": "group",
},
"ru": b24.Params{
"TITLE": "Titel",
"DESCRIPTION": "Beschreibung",
"GROUP_NAME": "Gruppe",
},
},
})
if err != nil {
return fmt.Errorf("placement.bind: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Typical use-cases and scenarios
Response Handling
HTTP status: 200
{
"result": true,
"time": {
"start": 1712132792.910734,
"finish": 1712132793.530359,
"duration": 0.6196250915527344,
"processing": 0.032338857650756836,
"date_start": "2024-04-03T10:26:32+02:00",
"date_finish": "2024-04-03T10:26:33+02:00",
"operating_reset_at": 1705765533,
"operating": 3.3076241016387939
}
}
Returned Data
|
Name |
Description |
|
result |
Returns the result of adding the widget handler. Possible values:
|
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400, 403, 200
{
"error": "ERROR_ARGUMENT",
"error_description": "Argument 'PLACEMENT' is null or empty",
"argument": "PLACEMENT"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Status |
|
|
Attempted to re-register the handler for a widget that allows only one registration: |
200 |
|
|
The |
200 |
|
|
The required |
200 |
|
|
A required field value is missing. The code of the required field is returned in |
200 |
|
|
Current authorization type is denied for this method Application context required |
403 |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Widget Handler
Thus, a successful call to the method placement.bind has allowed you to register a widget handler. It is important that the HANDLER_URL parameter you specify points to a real and accessible URL.
Important
It is required that the handler URL is definitely accessible from the external network. Links to localhost, local domains, and similar ways to access a local web server are not acceptable. Check the accessibility of the URL you specified using special services that monitor website availability!
When accessing your handler, Bitrix24 will send a POST message containing information about the widget context, such as the deal identifier if the widget is embedded in the deal card in CRM, etc.
You will find examples of such data in the descriptions of specific placements.