Item in the User Menu USER_PROFILE_MENU

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: placement, user

The widget adds its own item to the user menu — the one that opens from the avatar in the upper right corner. The menu is available from any page of Bitrix24, so the placement suits actions that are not tied to a section: personal application settings, a jump to your own section, sending data about yourself to an external service.

The placement code is specified in the PLACEMENT parameter of the placement.bind method.

The widget is not displayed in the interface until the application installation is complete. Check the application installation

Placement Code	Location
`USER_PROFILE_MENU`	Item in the user menu

Where to Find It in the Interface

Click the avatar in the upper right corner and select the Extensions button. The application item is displayed in the menu that opens, together with the built-in items.

The item name is set by the TITLE parameter during registration. If the parameter is not passed, the application name is displayed.

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

Key

Description

USER_ID
string

The identifier of the current user — the one who opened the menu.

The value does not depend on whose employee card is open on the page: the menu belongs to the current user. To get the identifier of the owner of the open card, use the USER_PROFILE_TOOLBAR placement

URI
string

The address of the page the widget is opened from. The menu is shown on every page of Bitrix24, so the value differs every time

This placement does not support 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 — name, position, department, time zone.

Code Examples

How to Use Examples in Documentation

cURL (OAuth)

JS (TS)

JS (UMD)

PHP

BX24.js

PHP CRest

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "USER_PROFILE_MENU",
            "HANDLER": "https://your-domain.com/widgets/profile-menu-handler.php",
            "TITLE": "My integration settings",
            "LANG_ALL": {
              "en": {
                "TITLE": "My integration settings"
              },
              "de": {
                "TITLE": "Meine Integrationseinstellungen"
              }
            },
            "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: 'USER_PROFILE_MENU',
              HANDLER: 'https://your-domain.com/widgets/profile-menu-handler.php',
              TITLE: 'My integration settings',
              LANG_ALL: {
                en: {
                  TITLE: 'My integration settings',
                },
                de: {
                  TITLE: 'Meine Integrationseinstellungen',
                },
              },
            },
            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('Placement bound successfully:', 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 bindUserProfileMenu() {
            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: 'USER_PROFILE_MENU',
                  HANDLER: 'https://your-domain.com/widgets/profile-menu-handler.php',
                  TITLE: 'My integration settings',
                  LANG_ALL: {
                    en: {
                      TITLE: 'My integration settings',
                    },
                    de: {
                      TITLE: 'Meine Integrationseinstellungen',
                    },
                  },
                },
                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('Placement bound successfully:', result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', bindUserProfileMenu)
        </script>

try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'USER_PROFILE_MENU',
                        'HANDLER' => 'https://your-domain.com/widgets/profile-menu-handler.php',
                        'TITLE' => 'My integration settings',
                        'LANG_ALL' => [
                            'en' => [
                                'TITLE' => 'My integration settings',
                            ],
                            'de' => [
                                'TITLE' => 'Meine Integrationseinstellungen',
                            ],
                        ],
                    ]
                );
        
            $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: 'USER_PROFILE_MENU',
                HANDLER: 'https://your-domain.com/widgets/profile-menu-handler.php',
                TITLE: 'My integration settings',
                LANG_ALL: {
                    en: {
                        TITLE: 'My integration settings'
                    },
                    de: {
                        TITLE: 'Meine Integrationseinstellungen'
                    }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'USER_PROFILE_MENU',
                'HANDLER' => 'https://your-domain.com/widgets/profile-menu-handler.php',
                'TITLE' => 'My integration settings',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'My integration settings',
                    ],
                    'de' => [
                        'TITLE' => 'Meine Integrationseinstellungen',
                    ],
                ],
            ]
        );
        
        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": "USER_PROFILE_MENU",
        	"HANDLER":   "https://your-domain.com/widgets/profile-menu-handler.php",
        	"TITLE":     "My integration settings",
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE": "My integration settings",
        		},
        		"en": b24.Params{
        			"TITLE": "My integration settings",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("placement.bind: %w", err)
        }
        
        // The response arrives as json.RawMessage — unmarshal it into the response
        // shape of the placement.bind method, see "Response Handling" on its page.
        fmt.Printf("%s\n", res.Result)

Continue Learning

Was the article helpful?

Overview of Placements

Item in the Employee Card Menu

Item in the User Menu USER_PROFILE_MENU

Where the Widget is EmbeddedWhere the Widget is Embedded

Where to Find It in the InterfaceWhere to Find It in the Interface

What the Handler ReceivesWhat the Handler Receives

PLACEMENT_OPTIONSPLACEMENT_OPTIONS

Relationship with Other ObjectsRelationship with Other Objects

Code ExamplesCode Examples

Continue LearningContinue Learning