Пункт в меню пользователя USER_PROFILE_MENU

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: placement, user

Виджет добавляет свой пункт в меню пользователя — то, которое открывается по аватару в правом верхнем углу. Меню доступно с любой страницы Битрикс24, поэтому точка подходит действиям, которые не привязаны к разделу: личные настройки приложения, переход в свой раздел, отправка данных о себе во внешний сервис.

Код точки встраивания указывается в параметре PLACEMENT метода placement.bind.

Виджет не отображается в интерфейсе, пока установка приложения не завершена. Проверьте установку приложения

Куда встраивается виджет

Код точки встраивания

Место

USER_PROFILE_MENU

Пункт в меню пользователя

Где находится в интерфейсе

Нажмите на аватар в правом верхнем углу и выберите кнопку Расширения. Пункт приложения выводится в открывшемся меню, вместе со встроенными пунктами.

Пункт в меню пользователя

Название пункта задается параметром TITLE при регистрации. Если параметр не передан, выводится название приложения.

Что получает обработчик

Данные передаются POST-запросом: часть параметров — в query-строке адреса обработчика, остальные — в теле запроса

Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => ru
            [APP_SID] => bbdb976c9f5d067b1d48d102ab17b995
            [AUTH_ID] => ae70bb6600705a0700005a4b00000001f0f107ab19f75f907d2320df1129aa61f63efc
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 9eefe26600705a0700005a4b00000001f0f1078586205803785eca5262f6ff48e025ee
            [SERVER_ENDPOINT] => https://oauth.bitrix24.tech/rest/
            [APPLICATION_TOKEN] => 5b2f8c1d7e3a9046b8c5d2f1a7e3b904
            [APPLICATION_SCOPE] => user,placement
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => USER_PROFILE_MENU
            [PLACEMENT_OPTIONS] => {"USER_ID":"1","URI":"\/company\/"}
        )
        

Обязательные параметры отмечены *

Параметры в query-строке адреса обработчика

Параметр
тип

Описание

DOMAIN*
string

Адрес Битрикс24, на котором был вызван обработчик виджета

PROTOCOL*
string

Защищенный или незащищенный протокол HTTP:

  • 0 — HTTP
  • 1 — HTTPS

LANG*
string

Язык интерфейса пользователя Битрикс24, который вызвал виджет. Вы можете локализовать язык интерфейса в своем виджете, ориентируясь на это значение

APP_SID*
string

Идентификатор сессии приложения. Битрикс24 создает его заново при каждой отрисовке виджета и использует, чтобы связать js-библиотеку с окружением приложения

Параметры в теле POST-запроса

Параметр
тип

Описание

AUTH_ID
string

Авторизационный токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для вызовов REST API от лица этого пользователя

AUTH_EXPIRES
integer

Время в секундах, после которого авторизационный токен станет неактуальным

REFRESH_ID
string

Refresh-токен OAuth 2, выписанный для пользователя, вызвавшего виджет. Можно использовать для обновления авторизационного токена от лица этого пользователя

SERVER_ENDPOINT*
string

Адрес сервера авторизации Битрикс24, необходимый для обновления токенов OAuth 2

APPLICATION_TOKEN*
string

Токен приложения. То же значение приходит в параметре application_token при вызове обработчиков событий. По нему обработчик виджета может проверить, что запрос пришел от Битрикс24

APPLICATION_SCOPE*
string

Список скоупов, выданных приложению, через запятую. Показывает, какие методы REST API доступны с полученным авторизационным токеном

member_id*
string

Уникальный строковый идентификатор Битрикс24, на котором был вызван обработчик виджета

status
string

Тип приложения, зарегистрировавшего обработчик данного виджета. Принимает значения:

PLACEMENT*
string

Код точки встраивания. Вы можете использовать один и тот же URL обработчика для всех своих виджетов. Значение, которое Битрикс24 будет сообщать в параметре PLACEMENT, поможет определить, из какой именно точки встраивания был вызван ваш обработчик в каждом конкретном случае

PLACEMENT_OPTIONS
string

Дополнительные данные в виде JSON-строки, определяющие контекст выполнения виджета. Например, это может быть массив, содержащий числовой идентификатор элемента CRM, в карточке которого был вызван обработчик виджета, и так далее. Параметр PLACEMENT_OPTIONS вместе с параметром PLACEMENT позволяет точно определить, для какой именно точки встраивания и какого объекта был вызван обработчик виджета

Битрикс24 добавляет в PLACEMENT_OPTIONS ключ URI — путь с query-строкой той страницы, с которой открыт виджет. Он приходит для любой точки встраивания, вместе с ее собственными ключами. Ключа не будет, если браузер не передал заголовок Referer или виджет открыт со страницы другого домена.

Как разобрать контекст вызова

PLACEMENT_OPTIONS приходит JSON-строкой, а не массивом: перед использованием разберите ее на стороне обработчика. Состав ключей у каждой точки свой и описан в разделе PLACEMENT_OPTIONS этой страницы.

$placement = $_POST['PLACEMENT'] ?? '';
        $options = json_decode($_POST['PLACEMENT_OPTIONS'] ?? '{}', true);
        
options = json.loads(request.form.get("PLACEMENT_OPTIONS", "{}") or "{}")
        

В B24JsSDK разбирать строку не нужно: свойство $b24.placement.options возвращает готовый объект, а $b24.placement.placement — код точки встраивания.

Что должен вернуть обработчик

Обработчик отвечает обычной HTML-страницей — Битрикс24 показывает ее во фрейме на месте виджета. Страница должна разрешать встраивание: если сервер приложения отдает заголовки X-Frame-Options или Content-Security-Policy, запрещающие фрейм, на месте виджета останется пустая область. Как это исправить, описано в статье Сайт не разрешает подключение.

PLACEMENT_OPTIONS

Ключ

Описание

USER_ID
string

Идентификатор текущего пользователя — того, кто открыл меню.

Значение не зависит от того, чья карточка сотрудника открыта на странице: меню принадлежит текущему пользователю. Чтобы получить идентификатор владельца открытой карточки, используйте точку USER_PROFILE_TOOLBAR

URI
string

Адрес страницы, с которой открыт виджет. Меню выводится на всех страницах Битрикс24, поэтому значение каждый раз разное

Точка не поддерживает параметр OPTIONS метода placement.bind: переданные значения не сохраняются, placement.get возвращает пустой массив.

Связь с другими объектами

Пользователь. По USER_ID из контекста вызова приложение получает данные сотрудника методом user.get — имя, должность, подразделение, часовой пояс.

Примеры кода

Как использовать примеры в документации

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": "Мои настройки интеграции",
            "LANG_ALL": {
              "ru": {
                "TITLE": "Мои настройки интеграции"
              },
              "en": {
                "TITLE": "My integration settings"
              }
            },
            "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: 'Мои настройки интеграции',
              LANG_ALL: {
                ru: {
                  TITLE: 'Мои настройки интеграции',
                },
                en: {
                  TITLE: 'My integration settings',
                },
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // Данные доступны только при успешном ответе
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Placement bound successfully:', result)
          }
        } catch (error) {
          // Ошибки транспорта и SDK (AjaxError, SdkError и другие)
          console.error(error)
        }
        
<!-- Подключение SDK (UMD-сборка), глобальный объект B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function bindUserProfileMenu() {
            try {
              // Инициализация SDK внутри фрейма Битрикс24
              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: 'Мои настройки интеграции',
                  LANG_ALL: {
                    ru: {
                      TITLE: 'Мои настройки интеграции',
                    },
                    en: {
                      TITLE: 'My integration settings',
                    },
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // Данные доступны только при успешном ответе
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Placement bound successfully:', result)
            } catch (error) {
              // Ошибки транспорта и SDK (AjaxError, SdkError и другие)
              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' => 'Мои настройки интеграции',
                        'LANG_ALL' => [
                            'ru' => [
                                'TITLE' => 'Мои настройки интеграции',
                            ],
                            'en' => [
                                'TITLE' => 'My integration settings',
                            ],
                        ],
                    ]
                );
        
            $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: 'Мои настройки интеграции',
                LANG_ALL: {
                    ru: {
                        TITLE: 'Мои настройки интеграции'
                    },
                    en: {
                        TITLE: 'My integration settings'
                    }
                }
            },
            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' => 'Мои настройки интеграции',
                'LANG_ALL' => [
                    'ru' => [
                        'TITLE' => 'Мои настройки интеграции',
                    ],
                    'en' => [
                        'TITLE' => 'My integration settings',
                    ],
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client и ctx уже созданы — см. раздел «SDK для Go»
        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":     "Мои настройки интеграции",
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE": "Мои настройки интеграции",
        		},
        		"en": b24.Params{
        			"TITLE": "My integration settings",
        		},
        	},
        })
        if err != nil {
        	return fmt.Errorf("placement.bind: %w", err)
        }
        
        // Ответ приходит как json.RawMessage — разберите его по форме ответа
        // метода placement.bind, см. раздел «Обработка ответа» на его странице.
        fmt.Printf("%s\n", res.Result)
        

Продолжите изучение