Context Menu Item for CRM Activity in CRM_XXX_ACTIVITY_TIMELINE_MENU, CRM_DYNAMIC_XXX_ACTIVITY_TIMELINE_MENU

{% note tip "" %}

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.

{% endnote %}

Scope: placement, crm

The widget adds its own item to the context menu of an activity record in the timeline of a CRM object card: a lead, deal, estimate, new invoice, or custom object type.

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

{% note info "" %}

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

{% endnote %}

Widget Placement

#| || Placement Code | Location || || CRM_LEAD_ACTIVITY_TIMELINE_MENU | Context menu item for a lead || || CRM_DEAL_ACTIVITY_TIMELINE_MENU | Context menu item for a deal || || CRM_QUOTE_ACTIVITY_TIMELINE_MENU | Context menu item for an estimate || || CRM_SMART_INVOICE_ACTIVITY_TIMELINE_MENU | Context menu item for new invoices || || CRM_DYNAMIC_XXX_ACTIVITY_TIMELINE_MENU | Context menu item for custom CRM object types. Replace XXX with the numeric identifier of the specific custom object type. For example, CRM_DYNAMIC_183_ACTIVITY_TIMELINE_MENU || |#

Where to Find It in the Interface

Open a CRM object card, find an activity record in the timeline, click ••• in the lower right corner of the record, and hover over Extensions. The application item appears in this submenu.

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 {.b24-info}

The example is shown for the CRM_DEAL_ACTIVITY_TIMELINE_MENU placement on an activity record.

Array
(
    [DOMAIN] => xxx.bitrix24.com
    [PROTOCOL] => 1
    [LANG] => en
    [APP_SID] => 4e0ec6b5f934a6af21bd9719f1d5444c
    [AUTH_ID] => b26f7166007e9c94001e30ba00000001f0f1075d0a9b2e73f14c86ad25e0b39
    [AUTH_EXPIRES] => 3600
    [REFRESH_ID] => a15e9966007e9c94001e30ba00000001f0f10769b3c04d182ea75f0cb384e12
    [SERVER_ENDPOINT] => https://oauth.bitrix.info/rest/
    [APPLICATION_TOKEN] => ec1b2074a9d3f5c81b6e40d27a95cf38
    [APPLICATION_SCOPE] => crm,placement
    [member_id] => d897063e1ce7c5eb9f04b9751eef5915
    [status] => L
    [PLACEMENT] => CRM_DEAL_ACTIVITY_TIMELINE_MENU
    [PLACEMENT_OPTIONS] => {"ENTITY_ID":"8061","ASSOCIATED_ENTITY_ID":"8097","ASSOCIATED_ENTITY_TYPE_ID":"6","URI":"\/crm\/deal\/details\/8061\/?any=details%2F8061%2F"}
)

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

{
    "ENTITY_ID": "8061",
    "ASSOCIATED_ENTITY_ID": "8097",
    "ASSOCIATED_ENTITY_TYPE_ID": "6",
    "URI": "/crm/deal/details/8061/?any=details%2F8061%2F"
}

{% include Note on required parameters %}

{% include notitle Description of Standard Data %}

PLACEMENT_OPTIONS

The PLACEMENT_OPTIONS value is passed as a JSON string with the call context. Along with the universal URI key, the context carries the identifiers of the object and of the timeline record.

The ENTITY_ID, ASSOCIATED_ENTITY_ID, and ASSOCIATED_ENTITY_TYPE_ID keys arrive for an activity record. The set of the remaining keys depends on the type of the timeline record the widget is opened on.

{% include Note on required parameters %}

#| || 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:

any object type crm.item.get specifying entityTypeId = '1' for leads, '2' for deals, and etc.
lead crm.lead.get
deal crm.deal.get
estimate crm.quote.get

The object type identifier does not arrive as a separate key. For a custom object type, take it from the PLACEMENT parameter value: for the CRM_DYNAMIC_183_ACTIVITY_TIMELINE_MENU code, the type identifier is 183

|| || ASSOCIATED_ENTITY_ID* string | The identifier of the CRM activity for which the widget was opened.

It can be used to retrieve additional information using the crm.activity.get method.

|| || ASSOCIATED_ENTITY_TYPE_ID* string | The identifier of the activity entity type.

|| || TYPE_ID* string | The identifier of the event type.

|| || TYPE_CATEGORY_ID* string | The identifier of the timeline record type.

|| || TIMELINE_ITEM_ID* string | The identifier of the timeline record.

|| |#

OPTIONS When Registering via placement.bind

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

Code Examples

{% include Footnote on examples %}

{% list tabs %}

cURL (OAuth)

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "PLACEMENT": "CRM_DEAL_ACTIVITY_TIMELINE_MENU",
    "HANDLER": "https://your-domain.com/widgets/crm-timeline-menu-handler.php",
    "TITLE": "My activity menu item",
    "LANG_ALL": {
      "en": {
        "TITLE": "My activity menu item"
      },
      "de": {
        "TITLE": "Mein Aktivitäten-Menüelement"
      }
    },
    "auth": "**put_access_token_here**"
  }' \
  https://**put_your_bitrix24_address**/rest/placement.bind

JS (TS)

// 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_ACTIVITY_TIMELINE_MENU',
      HANDLER: 'https://your-domain.com/widgets/crm-timeline-menu-handler.php',
      TITLE: 'My activity menu item',
      LANG_ALL: {
        en: {
          TITLE: 'My activity menu item',
        },
        de: {
          TITLE: 'Mein Aktivitäten-Menüelement',
        },
      },
    },
    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)
}

JS (UMD)

<!-- 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 bindCrmDealActivityTimelineMenu() {
    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_ACTIVITY_TIMELINE_MENU',
          HANDLER: 'https://your-domain.com/widgets/crm-timeline-menu-handler.php',
          TITLE: 'My activity menu item',
          LANG_ALL: {
            en: {
              TITLE: 'My activity menu item',
            },
            de: {
              TITLE: 'Mein Aktivitäten-Menüelement',
            },
          },
        },
        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', bindCrmDealActivityTimelineMenu)
</script>

PHP

try {
    $response = $b24Service
        ->core
        ->call(
            'placement.bind',
            [
                'PLACEMENT' => 'CRM_DEAL_ACTIVITY_TIMELINE_MENU',
                'HANDLER' => 'https://your-domain.com/widgets/crm-timeline-menu-handler.php',
                'TITLE' => 'My activity menu item',
                'LANG_ALL' => [
                    'en' => [
                        'TITLE' => 'My activity menu item',
                    ],
                    'de' => [
                        'TITLE' => 'Mein Aktivitäten-Menüelement',
                    ],
                ],
            ]
        );

    $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.js

BX24.callMethod(
    'placement.bind',
    {
        PLACEMENT: 'CRM_DEAL_ACTIVITY_TIMELINE_MENU',
        HANDLER: 'https://your-domain.com/widgets/crm-timeline-menu-handler.php',
        TITLE: 'My activity menu item',
        LANG_ALL: {
            en: { TITLE: 'My activity menu item' },
            de: { TITLE: 'Mein Aktivitäten-Menüelement' }
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);

PHP CRest

require_once('crest.php');

$result = CRest::call(
    'placement.bind',
    [
        'PLACEMENT' => 'CRM_DEAL_ACTIVITY_TIMELINE_MENU',
        'HANDLER' => 'https://your-domain.com/widgets/crm-timeline-menu-handler.php',
        'TITLE' => 'My activity menu item',
        'LANG_ALL' => [
            'en' => [
                'TITLE' => 'My activity menu item',
            ],
            'de' => [
                'TITLE' => 'Mein Aktivitäten-Menüelement',
            ],
        ],
    ]
);

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_ACTIVITY_TIMELINE_MENU",
	"HANDLER":   "https://your-domain.com/widgets/crm-timeline-menu-handler.php",
	"TITLE":     "My activity menu item",
	"LANG_ALL": b24.Params{
		"ru": b24.Params{
			"TITLE": "My activity menu item",
		},
		"en": b24.Params{
			"TITLE": "My activity menu item",
		},
	},
})
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)

{% endlist %}

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 cannot be found on an activity record | The item is located in the Extensions submenu: click ••• in the lower right corner of the record and hover over that item || |#

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

Navigation Menu

Uh oh!

Context Menu Item for CRM Activity in CRM_XXX_ACTIVITY_TIMELINE_MENU, CRM_DYNAMIC_XXX_ACTIVITY_TIMELINE_MENU

Widget Placement

Where to Find It in the Interface

What the Handler Receives

PLACEMENT_OPTIONS

OPTIONS When Registering via placement.bind

Code Examples

Common Mistakes

Continue Learning

Uh oh!

FilesExpand file tree

activity-timeline-menu.md

Latest commit

History

activity-timeline-menu.md

File metadata and controls

Context Menu Item for CRM Activity in CRM_XXX_ACTIVITY_TIMELINE_MENU, CRM_DYNAMIC_XXX_ACTIVITY_TIMELINE_MENU

Widget Placement

Where to Find It in the Interface

What the Handler Receives

PLACEMENT_OPTIONS

OPTIONS When Registering via placement.bind

Code Examples

Common Mistakes

Continue Learning