How to embed widgets in CRM
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.
Widgets add an application interface to the CRM. The user works with a card in Bitrix24, while the application interface appears inside the card: in a custom lead field or on a separate tab.
Two scenarios are available. The first shows how to add a field to a lead that opens the application interface. The second provides a video tutorial and materials on adding a tab to a CRM card.
Both scenarios require a handler — an application page with a public URL. Bitrix24 opens this URL in the CRM card and passes the call data to the handler. Each scenario specifies which data the handler receives.
Quick links: all scenarios
User documentation: CRM implementation steps
Getting Started
- Determine where the application interface should appear: in a lead field or on a CRM card tab
- Prepare a handler — an application page with a URL accessible from an external network
- Find the required scenario in the How to choose a scenario table
- Check which permissions and scope are specified in the chosen scenario
- Execute the methods in the order described in the scenario
- Complete the application installation and open a CRM card to verify the handler call
How to choose a scenario
|
If necessary |
Open |
|
Show the application interface inside the lead custom field |
|
|
Watch the video tutorial and materials on adding a tab to a CRM card |
|
|
Clarify tab codes and the data received by the handler |
|
|
Learn how custom CRM field types work |