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 placement

Who can execute the method: administrator or an employee with permission to create applications

The method placement.bind adds a handler for the widget placement.

The method works only in an application context. Calling it through a webhook returns WRONG_AUTH_TYPE.

A widget can be registered by:

  • the Bitrix24 administrator — in any application
  • an employee with the Who can create apps for everyone permission — in a local application the employee has access to. The permission is configured as described in How to Configure Access to Application Creation
  • the owner of a personal application — in their own application

An employee without administrator permissions registers a widget for all users or for themselves: any other USER_ID returns the ACCESS_DENIED error.

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
type

Description

PLACEMENT*
string

Placement code. The method converts it to uppercase. The code must be available to the application under its scopes

HANDLER*
string

Widget handler URL. Specify an address with the http or https scheme and a host name containing a dot

TITLE
string

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
string

Description of the widget in the interface. Not used in practice

GROUP_NAME
string

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
object

Object with TITLE, DESCRIPTION, and GROUP_NAME for the specified languages. If a nonempty LANG_ALL is passed, the method uses it instead of the corresponding top-level parameters. Users whose Bitrix24 interface uses one of these languages see localized names, descriptions, and groups:

{
            "en": {
                "TITLE": "title",
                "DESCRIPTION": "description",
                "GROUP_NAME": "group"
            },
            "de": {
                "TITLE": "Titel",
                "DESCRIPTION": "Beschreibung",
                "GROUP_NAME": "Gruppe"
            }
        }
        

OPTIONS
object

Additional display parameters for the widget. Specific values depend on the placement. Currently used in widgets for messengers, in the widget PAGE_BACKGROUND_WORKER, and in the widget CRM_XXX_DETAIL_ACTIVITY. Placements that do not accept OPTIONS, for example CRM_DEAL_DETAIL_TAB, discard the parameter without an error.

The length of OPTIONS after JSON encoding must not exceed 2048 characters. Cyrillic characters and the / character are escaped during encoding and take up more space than Latin characters. The limit includes the default values that the placement adds. For example, for IM_TEXTAREA they take 96 characters, so 1952 characters remain for the values you pass. The length is checked before the field contents. If the limit is exceeded, the method returns the ERROR_ARGUMENT error

ICON
object

Handler image. Pass fileData as an array containing the file name and its Base64-encoded content. The method stores the file as the registered handler's icon

USER_ID
integer

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 PAGE_BACKGROUND_WORKER.

If you pass a positive USER_ID for a placement that does not support per-user registration, the method returns ERROR_PLACEMENT_USER_MODE.

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();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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)
        

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
type

Description

result
boolean

true if the handler was registered successfully. On error, the method returns an error code and description

time
time

Information about the request execution time

Error Handling

HTTP status: 400, 403, 200

{
            "error": "ERROR_ARGUMENT",
            "error_description": "The value of an argument 'TITLE' must be of type string",
            "argument": "TITLE"
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Code

Description

Status

ERROR_PLACEMENT_MAX_COUNT

The registration limit for the placement was exceeded, for example for PAGE_BACKGROUND_WORKER or REST_APP_URI

400

ERROR_PLACEMENT_USER_MODE

USER_ID was passed for a placement that does not support per-user registration

400

INVALID_ERROR_ICON_NAME

Field iconName is invalid. — an invalid value, for example an empty string, was passed in OPTIONS[iconName] when registering the IM_SIDEBAR widget

200

EMPTY_ERROR_HANDLER_URL

The required OPTIONS[errorHandlerUrl] parameter was not passed when registering the PAGE_BACKGROUND_WORKER widget

200

ERROR_ARGUMENT

A required parameter is missing or has an invalid type. The name of the invalid parameter is returned in argument

400

ERROR_ARGUMENT

OPTIONS exceeds 2048 characters after JSON encoding — the length of OPTIONS after JSON encoding exceeds 2048 characters

400

ERROR_PLACEMENT_NOT_FOUND

The PLACEMENT code is unavailable to the application under its scopes

400

ERROR_WRONG_HANDLER_URL

The HANDLER URL has no host name containing a dot, for example localhost

400

ERROR_UNSUPPORTED_PROTOCOL

The HANDLER URL uses a scheme other than http or https

400

WRONG_AUTH_TYPE

The method was called outside an application context, for example through a webhook

403

ACCESS_DENIED

The caller does not have permission to register the application's widgets, or USER_ID specifies another user

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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

Pass the widget handler URL in HANDLER. After a successful placement.bind call, Bitrix24 registers the handler for the selected placement.

When registering the handler, the method checks for the http or https scheme and a dot in the host name. localhost fails this check. Ensure Bitrix24 can reach the handler from the external network: the method does not check server availability.

For most placements, Bitrix24 calls the handler with a POST request. The request contains application authorization and placement context. For example, a deal card tab receives the deal ID in PLACEMENT_OPTIONS. Some placements call the handler differently or do not pass data.

Request format, data fields, and exceptions are described on the placement pages.

Continue Learning