Tab in the detail form of the CRM entity CRM_XXX_DETAIL_TAB, CRM_DYNAMIC_XXX_DETAIL_TAB

Scope: crm

You can add your own tabs to the detail form of CRM objects: leads, contacts, companies, deals, estimates, new invoices, custom object types.

Widget as a tab in the detail form of the CRM entity

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

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

Where the widget is embedded

Placement Code

Location

CRM_LEAD_DETAIL_TAB

Tab in the lead detail form

CRM_DEAL_DETAIL_TAB

Tab in the deal detail form

CRM_CONTACT_DETAIL_TAB

Tab in the contact detail form

CRM_COMPANY_DETAIL_TAB

Tab in the company detail form

CRM_QUOTE_DETAIL_TAB

Tab in the estimate detail form

CRM_SMART_INVOICE_DETAIL_TAB

Tab in the invoice detail form

CRM_DYNAMIC_XXX_DETAIL_TAB

Tab in the detail form of a custom object type in CRM. Instead of XXX, specify the numeric identifier of the specific custom object type. For example, CRM_DYNAMIC_183_DETAIL_TAB

What the handler receives

Data is transmitted as a POST request


        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 32dc7a69a3dac11ea9c95dfc6bf5dd8a
            [AUTH_ID] => 1bf49f6600631fcd00005a4b00000001f0f107e9a9ddb6de2bd5f7856ac587b492adb4
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 0b73c76600631fcd00005a4b00000001f0f1079fd883d9c43bf4abf545709c61eb8f69
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_LEAD_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"6591"}
        )
        
        

        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => d8286e173e919aa1695254997a6e3123
            [AUTH_ID] => 3cf49f6600631fcd00005a4b00000001f0f107d9825065d14b0d269c63cdaa0bb1967d
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 2c73c76600631fcd00005a4b00000001f0f1076f22983f060e8e14120e47cbc2c227a0
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_DEAL_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"3473"}
        )
        
        

        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => d17a24f20960a2971eda0e69754e62a2
            [AUTH_ID] => 57f49f6600631fcd00005a4b00000001f0f1077ef2d8b6c37097b8985bb7fb4948d1e8
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 4773c76600631fcd00005a4b00000001f0f10711f2f134f53a44072e44b61677961fac
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_CONTACT_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"13037"}
        )
        
        

        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 1ff08edeb6a06f8f35a28fd745039801
            [AUTH_ID] => 74f49f6600631fcd00005a4b00000001f0f1070281f446cf788ea6bd54f8420750aaea
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 6473c76600631fcd00005a4b00000001f0f107b5ee25f08705b5f616a23e2130eb7fad
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_COMPANY_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"2946"}
        )
            
        

        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 5571169e21118b274f4fa57b8fd4e2b3
            [AUTH_ID] => aef49f6600631fcd00005a4b00000001f0f1079f066b85d07bc74dc9f4372d83152d70
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 9e73c76600631fcd00005a4b00000001f0f107541600cc2176b7d270db8ab3f1eecfcf
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_QUOTE_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"5"}
        )
        
        

        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => fff172819907af99a29b4830304aabe7
            [AUTH_ID] => ccbfca670076a4b8006f518000000001201c07b80ac830a875756c6c0c9073bec005c5
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => bc3ef2670076a4b8006f518000000001201c07efcbf35af9b89bb15ea3ab8e7223fe49
            [member_id] => e8857f161a1a8288f312b6cc6ad67995
            [status] => L
            [PLACEMENT] => CRM_SMART_INVOICE_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"32"}
        )
        
        

        Array
        (
            [DOMAIN] => xxx.bitrix24.com
            [PROTOCOL] => 1
            [LANG] => en
            [APP_SID] => 5d7bde16d7895ef326320f00c4bfbd8d
            [AUTH_ID] => def49f6600631fcd00005a4b00000001f0f10700d7b3563b156732e94917116f0a81a1
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => ce73c76600631fcd00005a4b00000001f0f1072e9cc05d2796e9b91abaa262fc98bdf9
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => CRM_DYNAMIC_183_DETAIL_TAB
            [PLACEMENT_OPTIONS] => {"ID":"3"}
        )

Required parameters are marked with *

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

String identifier of the application that registered the widget handler

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

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:

PLACEMENT*
string

Code for the widget embedding location. 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 widget embedding location 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 entity 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 widget embedding location and object the widget handler was invoked.

PLACEMENT_OPTIONS

The value of PLACEMENT_OPTIONS is a JSON string containing an array of one or more keys.

Required parameters are marked with *

Parameter

Description

ID*
string

Identifier of the CRM object for which the widget was opened.

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

In the case of embedding the widget in a custom object, the type identifier can be obtained from the value of the PLACEMENT parameter. In the example above — 183

Typical use-cases and scenarios

Continue exploring

Previous
Dropdown menu item above the list of entities
Next
Button above the timeline of the entity