Widget in the Task Card TASK_VIEW_TAB

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

Scope: placement, task

The widget adds the application interface to the task card. Until module version tasks 25.700.0 it was rendered as a separate tab; in the new card it is a row in the Applications block.

This placement is chosen when the application needs a screen of its own inside a task: data from an external service, a report, or a form next to the task fields.

If the application registers several card placements, the block shows one row per placement. One placement is enough for a new integration.

The widget can be limited to tasks of specific projects with the groupId connection parameter — see OPTIONS at registration.

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

TASK_VIEW_TAB

Row in the Applications block of the task card

Where to Find It in the Interface

Open a task. The application row is rendered below the task fields in the Applications block. The row name is the TITLE value passed at registration.

Row in the Applications block of the task card

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] => 0063a02ba25315469678f946ece50010
            [AUTH_ID] => 9c52ba6600705a0700005a4b00000001f0f107e81691773d119eb941ad045e36
            [AUTH_EXPIRES] => 3600
            [REFRESH_ID] => 8cd1e16600705a0700005a4b00000001f0f1070aef2cbe270a6f27bcaf791e45
            [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
            [APPLICATION_TOKEN] => 3f0a7c19e5b84d2196c8ad470e5f2b31
            [APPLICATION_SCOPE] => task,placement
            [member_id] => da45a03b265edd8787f8a258d793cc5d
            [status] => L
            [PLACEMENT] => TASK_VIEW_TAB
            [PLACEMENT_OPTIONS] => {"taskId":"31","URI":"\/company\/personal\/user\/1\/tasks\/task\/view\/31\/"}
        )
        
        

After parsing, the PLACEMENT_OPTIONS string from this example looks like this:

{
            "taskId": "31",
            "URI": "/company/personal/user/1/tasks/task/view/31/"
        }
        

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. In addition to the universal URI key, the context carries the key of the placement itself.

Required parameters are marked with *

Parameter

Description

taskId*
string

Identifier of the task whose card the widget is opened from.

Task data is returned by the tasks.task.get method

URI
string

Address of the Bitrix24 page the widget is opened from

OPTIONS at Registration via placement.bind

Connection parameters are passed in OPTIONS of the placement.bind method when the handler is registered. This is not the data that Bitrix24 passes to the handler when the placement is called: that data is described in the "What the Handler Receives" section.

Parameter

Description

groupId
string

Limits the widget to tasks of the listed projects. The value is a comma-separated list of project identifiers, for example 11,12.

If the parameter is not passed or is empty, the widget is displayed in all tasks. If the parameter is filled in, the widget is displayed only in tasks of the listed projects and is not displayed in tasks without a project

Code Examples

How to Use Examples in Documentation

The examples pass the OPTIONS parameter with the project identifiers 11,12. Remove it if the widget has to be displayed in all tasks.

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{
            "PLACEMENT": "TASK_VIEW_TAB",
            "HANDLER": "https://your-domain.com/widgets/task-view-tab-handler.php",
            "TITLE": "My task widget",
            "OPTIONS": {
              "groupId": "11,12"
            },
            "LANG_ALL": {
              "en": {
                "TITLE": "My task widget"
              },
              "de": {
                "TITLE": "Mein Aufgaben-Widget"
              }
            },
            "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: 'TASK_VIEW_TAB',
              HANDLER: 'https://your-domain.com/widgets/task-view-tab-handler.php',
              TITLE: 'My task widget',
              OPTIONS: {
                groupId: '11,12',
              },
              LANG_ALL: {
                en: {
                  TITLE: 'My task widget',
                },
                de: {
                  TITLE: 'Mein Aufgaben-Widget',
                },
              },
            },
            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 bindTaskViewTab() {
            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: 'TASK_VIEW_TAB',
                  HANDLER: 'https://your-domain.com/widgets/task-view-tab-handler.php',
                  TITLE: 'My task widget',
                  OPTIONS: {
                    groupId: '11,12',
                  },
                  LANG_ALL: {
                    en: {
                      TITLE: 'My task widget',
                    },
                    de: {
                      TITLE: 'Mein Aufgaben-Widget',
                    },
                  },
                },
                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', bindTaskViewTab)
        </script>
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'placement.bind',
                    [
                        'PLACEMENT' => 'TASK_VIEW_TAB',
                        'HANDLER' => 'https://your-domain.com/widgets/task-view-tab-handler.php',
                        'TITLE' => 'My task widget',
                        'OPTIONS' => [
                            'groupId' => '11,12',
                        ],
                        'LANG_ALL' => [
                            'en' => [
                                'TITLE' => 'My task widget',
                            ],
                            'de' => [
                                'TITLE' => 'Mein Aufgaben-Widget',
                            ],
                        ],
                    ]
                );
        
            $result = $response->getResponseData()->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'placement.bind',
            {
                PLACEMENT: 'TASK_VIEW_TAB',
                HANDLER: 'https://your-domain.com/widgets/task-view-tab-handler.php',
                TITLE: 'My task widget',
                OPTIONS: {
                    groupId: '11,12'
                },
                LANG_ALL: {
                    en: { TITLE: 'My task widget' },
                    de: { TITLE: 'Mein Aufgaben-Widget' }
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'placement.bind',
            [
                'PLACEMENT' => 'TASK_VIEW_TAB',
                'HANDLER' => 'https://your-domain.com/widgets/task-view-tab-handler.php',
                'TITLE' => 'My task widget',
                'OPTIONS' => [
                    'groupId' => '11,12',
                ],
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'My task widget',
                    ],
                    'de' => [
                        'TITLE' => 'Mein Aufgaben-Widget',
                    ],
                ],
            ]
        );
        
        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": "TASK_VIEW_TAB",
        	"HANDLER":   "https://your-domain.com/widgets/task-view-tab-handler.php",
        	"TITLE":     "My task widget",
        	"OPTIONS": b24.Params{
        		"groupId": "11,12",
        	},
        	"LANG_ALL": b24.Params{
        		"ru": b24.Params{
        			"TITLE": "My task widget",
        		},
        		"en": b24.Params{
        			"TITLE": "My task widget",
        		},
        	},
        })
        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

The widget has appeared in some tasks only

Check groupId: the widget is displayed only in tasks of the projects listed in it — see OPTIONS at registration

The handler does not find the task identifier

Read the identifier from the taskId key. The ID key arrives with the TASK_LIST_CONTEXT_MENU placement in the context menu of the list

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

Continue Learning