Widgets in User Profile: Overview of Placements

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.

The placements of this section add an application item where the user works with profiles: to the user's own menu and to the employee card. Both placements require the user scope.

To register a widget, use the placement.bind method and pass the required code in the PLACEMENT parameter.

Quick navigation: all placements

How to Choose a Placement

The placements differ in whose identifier the handler receives.

Placement	Where the User Sees It	When to Use
USER_PROFILE_MENU	In the menu under the avatar in the upper right corner, via the Extensions button	When the action relates to the user themselves: personal application settings, a jump to your own section. The handler receives the identifier of the person who opened the menu
USER_PROFILE_TOOLBAR	In the menu of the button in the upper right corner of the employee card	When the action relates to a specific employee: data from an external system, a request about a person. The handler receives the identifier of the owner of the open card

How to Get Started

Choose the placement by whose identifier the handler needs
Register the handler with the placement.bind method, pass the placement code in PLACEMENT and the item name in TITLE
Complete the application installation — until then the item does not appear in the interface
Open the user menu or an employee card and select your item
Parse PLACEMENT_OPTIONS in the handler and retrieve employee data with the user.get method

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] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => bbdb976c9f5d067b1d48d102ab17b995
            [AUTH_ID] => ae70bb6600705a0700005a4b00000001f0f107ab19f75f907d2320df1129aa61f63efc
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 9eefe26600705a0700005a4b00000001f0f1078586205803785eca5262f6ff48e025ee
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => 5b2f8c1d7e3a9046b8c5d2f1a7e3b904
            [APPLICATION_SCOPE] => user,placement
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => USER_PROFILE_MENU
            [PLACEMENT_OPTIONS] => {"USER_ID":"1","URI":"\/company\/"}
        )

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 call context. The set of keys is the same for both placements, but the value of USER_ID differs.

Placement	Keys	What Is in USER_ID
USER_PROFILE_MENU	`USER_ID`, `URI`	The current user — the one who opened the menu
USER_PROFILE_TOOLBAR	`USER_ID`, `URI`	The owner of the open employee card

The URI key is universal: it carries the address of the page the widget is opened from.

Neither placement supports the OPTIONS parameter of the placement.bind method: the values passed are not retained, and placement.get returns an empty array.

Relationship With Other Objects

User. Using USER_ID from the call context, the application retrieves employee data with the user.get method. The list of employees and the company structure are returned by the methods of the Users: Overview of Methods and Company Structure: Overview of Methods sections.

Common Mistakes

Mistake	Solution
The item did not appear after registration	Complete the application installation and reload the page: the menu and the card build the item list on load
The handler receives the wrong employee	Check the placement code: `USER_PROFILE_MENU` returns the current user, while `USER_PROFILE_TOOLBAR` returns the owner of the open card
The `OPTIONS` passed during registration does not reach the handler	The placements of this section do not support `OPTIONS`. Pass your values through the handler address

Overview of Placements

Scope: placement, user

Placement	When to Use
USER_PROFILE_MENU	An item in the user menu, available from any page of Bitrix24
USER_PROFILE_TOOLBAR	An item in the employee card menu

Continue Learning

Was the article helpful?

Connector Settings Page

Item in the User Menu

Widgets in User Profile: Overview of Placements

How to Choose a PlacementHow to Choose a Placement

How to Get StartedHow to Get Started

What the Handler ReceivesWhat the Handler Receives

PLACEMENT_OPTIONSPLACEMENT_OPTIONS

Relationship With Other ObjectsRelationship With Other Objects

Common MistakesCommon Mistakes

Overview of PlacementsOverview of Placements

Continue LearningContinue Learning