Dropdown Menu Item for the Document Generator CRM_XXX_DOCUMENTGENERATOR_BUTTON

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, crm

The widget adds its own item to the dropdown menu of the document generator of a CRM object. The placement suits applications that build a document for the object on their own side: a printed form, a contract, or an act.

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

Where the Widget is Embedded

Placement Code

Location

CRM_LEAD_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for a lead

CRM_CONTACT_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for a contact

CRM_COMPANY_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for a company

CRM_DEAL_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for a deal

CRM_SMART_INVOICE_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for a new invoice

CRM_QUOTE_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for an estimate

CRM_DYNAMIC_XXX_DOCUMENTGENERATOR_BUTTON

Item in the dropdown menu of the document generator for a custom CRM object type. Instead of XXX, specify the numeric identifier of the specific custom object type. For example, CRM_DYNAMIC_183_DOCUMENTGENERATOR_BUTTON

Where to Find It in the Interface

Open a CRM entity form, click the Document button at the top of the form, and hover over the Extensions item. The application item appears in this submenu, next to the knowledge bases and Bitrix24 Market.

Application item in the dropdown menu of the deal document generator

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

The example is shown for the CRM_DEAL_DOCUMENTGENERATOR_BUTTON placement. Other codes send the same set of data: the PLACEMENT value and the object identifier in PLACEMENT_OPTIONS change.


        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 23ab3058338edf7c4c30a52e4d0b3f94
            [AUTH_ID] => 83fd7166007e9c94001e30ba00000001f0f107a52e6ad7ef9a1b8c3d5e2f4061
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 737c9966007e9c94001e30ba00000001f0f1072b8d4e6f01a3c57d9e8b2f4160
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
            [APPLICATION_SCOPE] => crm,documentgenerator,placement
            [member_id] => d897063e1ce7c5eb9f04b9751eef5915
            [status] => L
            [PLACEMENT] => CRM_DEAL_DOCUMENTGENERATOR_BUTTON
            [PLACEMENT_OPTIONS] => {"ENTITY_ID":"5","URI":"\/crm\/deal\/details\/5\/?any=details%2F5%2F"}
        )
        
        

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 PLACEMENT_OPTIONS value is passed as a JSON string with the call context. Besides the universal URI key, the context contains the key of the placement itself.

Required parameters are marked with *

Parameter

Description

ENTITY_ID*
string

The identifier of the CRM object for which the widget was opened.

It can be used to retrieve additional information using the corresponding methods:

The object type identifier does not arrive as a separate key. For a custom object type it can be taken from the value of the PLACEMENT parameter: for the CRM_DYNAMIC_183_DOCUMENTGENERATOR_BUTTON code, the type identifier is 183

OPTIONS when registering via placement.bind

The placement does not support the OPTIONS parameters. Passed values are not saved: the placement.get method returns an empty array for such a registration.

Code Examples

How to Use Examples in Documentation

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "CRM_DEAL_DOCUMENTGENERATOR_BUTTON",
            "HANDLER": "https://your-domain.com/widgets/crm-document-handler.php",
            "TITLE": "Supply contract",
            "LANG_ALL": {
              "en": {
                "TITLE": "Supply contract"
              },
              "de": {
                "TITLE": "Liefervertrag"
              }
            },
            "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: 'CRM_DEAL_DOCUMENTGENERATOR_BUTTON',
              HANDLER: 'https://your-domain.com/widgets/crm-document-handler.php',
              TITLE: 'Supply contract',
              LANG_ALL: {
                en: {
                  TITLE: 'Supply contract',
                },
                de: {
                  TITLE: 'Liefervertrag',
                },
              },
            },
            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 bindCrmDocumentGeneratorButton() {
            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: 'CRM_DEAL_DOCUMENTGENERATOR_BUTTON',
                  HANDLER: 'https://your-domain.com/widgets/crm-document-handler.php',
                  TITLE: 'Supply contract',
                  LANG_ALL: {
                    en: {
                      TITLE: 'Supply contract',
                    },
                    de: {
                      TITLE: 'Liefervertrag',
                    },
                  },
                },
                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', bindCrmDocumentGeneratorButton)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'CRM_DEAL_DOCUMENTGENERATOR_BUTTON',
                        'HANDLER' => 'https://your-domain.com/widgets/crm-document-handler.php',
                        'TITLE' => 'Supply contract',
                        'LANG_ALL' => [
                            'en' => [
                                'TITLE' => 'Supply contract',
                            ],
                            'de' => [
                                'TITLE' => 'Liefervertrag',
                            ],
                        ],
                    ]
                );
        
            $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: 'CRM_DEAL_DOCUMENTGENERATOR_BUTTON',
                HANDLER: 'https://your-domain.com/widgets/crm-document-handler.php',
                TITLE: 'Supply contract',
                LANG_ALL: {
                    en: { TITLE: 'Supply contract' },
                    de: { TITLE: 'Liefervertrag' }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'CRM_DEAL_DOCUMENTGENERATOR_BUTTON',
                'HANDLER' => 'https://your-domain.com/widgets/crm-document-handler.php',
                'TITLE' => 'Supply contract',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'Supply contract',
                    ],
                    'de' => [
                        'TITLE' => 'Liefervertrag',
                    ],
                ],
            ]
        );
        
        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": "CRM_DEAL_DOCUMENTGENERATOR_BUTTON",
        	"HANDLER":   "https://your-domain.com/widgets/crm-document-handler.php",
        	"TITLE":     "Supply contract",
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE": "Supply contract",
        		},
        		"en": b24.Params{
        			"TITLE": "Supply contract",
        		},
        	},
        })
        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)
        

Common Mistakes

Mistake

Solution

placement.bind returns WRONG_AUTH_TYPE with the description Application context required

Register the placement on behalf of an application. A placement cannot be bound with a webhook

placement.bind returns ERROR_PLACEMENT_NOT_FOUND

The code is assembled for an object type that this placement does not support, or the application has not been granted the crm scope. Check the code against the table at the beginning of the page

The widget is registered but does not appear in the interface

Complete the application installation and reload the page

The item is not visible in the Document button menu

Hover over the Extensions item: the application item is displayed in this submenu

Other registration error codes are listed in the "Possible Error Codes" section of the placement.bind page.

Continue Learning