Widget Development for Bitrix24: From Audit to Deployment

Widget Development for Bitrix24: From Audit to Deployment

A classic scenario: the CRM is already in use, managers handle all deals, but you need to add a block on the deal card with data from an external system—for example, warehouse stock from an ERP or delivery status from a transport company. Standard tools won't cut it; you need a widget via the REST API and the UI Extensions embedding mechanism. We at our company regularly solve such tasks: ERP integration, delivery status synchronization, displaying fiscal receipts from OFD directly in the lead card. Over the years, we've developed a clear approach to widget development: from auditing business processes to publishing in the Marketplace. In this article, we share practical insights.

Widgets in Bitrix24 are a separate type of application that renders inside the portal interface via iframe or JS SDK. In recent portal versions, Bitrix is actively developing the concept of UI Extensions as a more performant and convenient alternative to classic iframe widgets. Let's break down what to choose for a specific task and how everything works under the hood.

How to Choose Between iframe and UI Extensions?

What Types of Widgets and Embedding Places Exist?

Bitrix24 supports several embedding mechanisms:

• Placement API (BX24.placement.call) — the classic way: the app registers a placement, Bitrix24 displays it in the appropriate interface location.
• UI Extensions — a set of ready-made components (Button, Dialog, Loader, Alert) available via @bitrix24/b24jssdk.
• Slider — opening an arbitrary URL in a side panel via BX24.openApplication().

Current placements are registered during app installation via the app.option.set method and stored in the b_app_option table. List of available embedding points:

Each placement passes contextual information to the widget: entity ID, type, access rights. More about placements can be found in the official documentation.

How Does an iframe Widget Work?

A typical widget consists of two parts: a server-side handler (endpoint that returns the widget page HTML) and client code inside the iframe.

Initialization in client code:

BX24.init(() => {
    const placement = BX24.placement.info();
    const dealId = placement.options.ID;

    BX24.callMethod('crm.deal.get', { id: dealId }, (result) => {
        if (result.error()) {
            console.error(result.error());
            return;
        }
        renderWidget(result.data());
    });
});

iframe height is a common issue. Bitrix24 does not make the iframe automatically elastic. After rendering content, you must explicitly call:

BX24.fitWindow(() => {
    // callback after height change
});

If not done, the widget will be cut off or an internal scrollbar appears.

Why Are UI Extensions Faster?

In recent portal versions, it's recommended to use @bitrix24/b24jssdk. It provides typed access to the REST API directly from the iframe:

import { initializeB24Frame, B24Frame } from '@bitrix24/b24jssdk';

const $b24 = await initializeB24Frame();
const profile = await $b24.fetchProfile();
const result = await $b24.callMethod('crm.deal.list', {
    filter: { ASSIGNED_BY_ID: profile.id },
    select: ['ID', 'TITLE', 'STAGE_ID']
});

The SDK handles authorization (OAuth token is passed automatically via postMessage), no need to store client_secret on the client. UI Extensions starts 30% faster than an iframe widget due to the direct event bus.

Placement Registration and App Manifest

The app registers placements during installation via the OnAppInstall hook. Example in the manifest:

{
  "placements": [
    {
      "placement": "CRM_DEAL_DETAIL_TAB",
      "handler": "https://myapp.example.com/widget/deal-tab",
      "title": "ERP Data",
      "description": "Stock and reserves by deal items"
    }
  ]
}

Or programmatically via REST:

POST /rest/placement.bind
{
  "PLACEMENT": "CRM_DEAL_DETAIL_TAB",
  "HANDLER": "https://myapp.example.com/widget/deal-tab",
  "TITLE": "Warehouse"
}

Why OAuth Security Matters?

All requests from the iframe to the server must pass AUTH_ID (short-lived token, 1 hour) or use REFRESH_TOKEN to refresh it. Never store client_secret in client code—only on the server.

Validate incoming event from postMessage:

window.addEventListener('message', (event) => {
    if (event.origin !== 'https://your-portal.bitrix24.ru') return;
    // processing
});

OAuth is a key security element. Experience shows that most widget development errors are related to incorrect token handling. More about OAuth can be found on Wikipedia.

Typical Mistakes and Their Solutions

• Content Security Policy (CSP) of Bitrix24 restricts frame-ancestors. Your app domain must be whitelisted, which is configured automatically when publishing in the Marketplace or registering a local application.
• Slow initialization of BX24.init() — if the widget loads longer than 3 seconds, users switch to another tab. Optimization: load bx24.js via CDN, show a skeleton loader until data arrives.
• Cross-domain cookies — for session authorization of your backend, use SameSite=None; Secure, otherwise the browser blocks cookies inside the iframe.

If you encounter any of these issues, contact us. Our certified specialists will help diagnose and fix the problem. Get in touch for a free project evaluation.

What the Work Includes

• Audit of current CRM and integration scenarios
• Design of widget architecture with security in mind
• Implementation and testing in multiple browsers (Chrome, Firefox, Safari, mobile apps)
• Integration with external systems (ERP, OFD, transport companies)
• Documentation for installation and maintenance
• Training of portal administrators

We provide a warranty on all completed work. Therefore, we use only proven solutions and years of experience.

Development Timeline

The main time is spent not on the widget itself, but on setting up OAuth authorization, handling edge cases (expired token, portal in a different datacenter), and testing in multiple browsers—Bitrix24 supports Chrome, Firefox, Safari, and mobile apps with different iframe behavior.

Order widget development today. We'll evaluate your project for free. Contact us to discuss the details.

1C-Bitrix Module Development and Setup

The main trap of Bitrix is init.php. You add an OnBeforeIBlockElementUpdate handler there, then another one — a year later the file is 2000 lines, and on every hit all that code executes. We move business logic into full-fledged modules with D7 ORM, custom tables, and administrative interface. The module can be disabled, transferred to another project, covered with tests — none of that is possible with init.php. Our team has 10+ years of Bitrix experience, certified specialists, and a 6-month code guarantee. Request a consultation — we'll explain how to migrate legacy code to a modular architecture.

Why is init.php the worst place for business logic?

Init.php does not support class autoloading, lacks an isolated namespace, cannot be unit tested, and cannot be disabled without editing the file itself. Every handler written there runs on every request, even if not needed. In a module, you register handlers through EventManager, and they only execute when the event occurs. Performance difference: up to 3x with 10+ handlers.

Standard Modules: Typical Problems and Solutions

Information blocks. IBlock architecture is the first thing we review on any project. A classic mistake: one catalog infoblock with 80 properties, 30 of which are multiple. The b_iblock_element_property table swells to millions of rows, and CIBlockElement::GetList with filtering on three properties does a full scan. We move reference data to Highload-blocks, eliminate multiple properties where possible, and design the structure for 5x growth.

e-Store (sale). Cart business rules are a separate story. We set discount priorities to prevent two campaigns from giving 60% instead of 30%, connect payment handlers, and write custom validation via OnSaleOrderBeforeSaved.

Search. The built-in search module with morphology works up to 10–15 thousand elements. Beyond that — Elasticsearch. We configure it via the Bitrix search module API, indexing through CSearchFullText or custom indexers.

Highload-blocks for dictionaries, logs, user data — instead of bloated IBlocks. Direct queries via Bitrix\Highloadblock\HighloadBlockTable, custom tables instead of the EAV structure of standard infoblocks. A million records — no degradation.

Mail events. Configuration is not just templates in b_event_message. The key is SPF, DKIM, DMARC on the DNS, otherwise transactional emails go to spam. We check deliverability and set up bounce handling.

How to Design Infoblocks for Performance?

We use Highload-blocks for reference data (colors, sizes, manufacturers) that are not involved in complex queries. For SKUs — a separate infoblock with linking via IBLOCK_ELEMENT_PROPERTY. Enable INDEX_PROPERTY for frequently filtered properties. Tagged caching: when an element changes, only the related cache is cleared. Highload-blocks process up to 10x faster than infoblocks with multiple properties on volumes of 100,000 records.

Custom Module Development

Each module follows the structure /local/modules/vendor.modulename/:

• install/index.php — setup class, create tables via $DB->RunSQLBatch()
• lib/ — D7 ORM classes, extending Bitrix\Main\ORM\Data\DataManager
• admin/ — administrative pages using CAdminList, CAdminForm
• include.php — autoloading, event handler registration via EventManager::getInstance()->registerEventHandler()
• REST API endpoints via \Bitrix\Rest\RestManager

The module registers in the system, appears in the "Installed Solutions" list, and has its own settings at /bitrix/admin/settings.php?mid=vendor.modulename. It can be enabled, disabled, and updated through UpdateSystem or custom migration mechanics.

Examples of implemented tasks:

• Campaign management — visual condition builder via CAdminCalendar, timers via agents (CAgent::AddAgent), analytics linked to the sale module
• Cost calculator — React widget on the frontend, REST API in the module, formulas stored in a Highload-block
• Booking system — real-time calendar, locking via $DB->StartTransaction() / $DB->Commit() on concurrent requests, integration with channel manager via webhook

Components and Composite Cache

Component customization via result_modifier.php and component_epilog.php, not by editing template.php of the standard template. This way core updates are painless.

Composite cache ("Composite Site" technology) — the server sends ready HTML, bypassing PHP routing. Dynamic areas (cart, authorization) are loaded via CBitrixComponent::setFrameMode(true) and AJAX. TTFB drops to 30–50 ms. But there are caveats: not all components are compatible, $APPLICATION->ShowPanel() breaks composite, and careful markup of <div id="bx-composite-..."> is required.

What to Check Before Installing a Marketplace Module?

Before installing a module from the marketplace, an audit is mandatory. We check: SQL queries without prepared statements (hello SQL injection), direct use of $_REQUEST without filtering, use of outdated kernel API instead of D7, conflicts with the composite cache module. A module with no updates for over a year and a few dozen installations is likely a problem on the next PHP update. A typical case: a module calls CIBlockElement::GetList with no cache reset — the site crashes with 5000 elements.

Migration to D7

When upgrading PHP or switching to a new edition — refactor outdated calls:

• CIBlockElement::GetList() → Bitrix\Iblock\Elements\ElementTable::getList()
• CSaleOrder::GetList() → Bitrix\Sale\Order::getList()
• CModule::IncludeModule() → Bitrix\Main\Loader::includeModule() Testing on staging, rollback via git on issues.

According to official 1C-Bitrix documentation, D7 ORM is the recommended tool for working with data, providing type safety and automatic query generation.

Comparison: Init.php vs Module

Module Development Scope and Cost

What is included in module development?

• Technical specification and architectural plan
• Code following PSR-4 and Bitrix code style
• Unit tests (PHPUnit) for business logic
• Integration tests for events and REST API
• Installation, configuration, and API documentation
• Repository and documentation access
• Administrator training for module usage
• 6-month warranty support

Estimated timelines and complexity:

Cost is calculated individually — contact us for a project estimate.

Module Testing

Unit tests via PHPUnit cover business logic: discount calculation, validation, document generation. Mocks for Bitrix\Main\Application::getConnection() allow tests to be DB-independent. Integration tests verify event handlers on a real database — OnAfterIBlockElementAdd, OnSaleOrderSaved, etc. REST API endpoints are tested via curl or PHPUnit HTTP client. Critical for modules working with b_sale_order, b_catalog_price — where errors cost money.

Compatibility is checked on PHP 7.4, 8.0, 8.1, 8.2 and editions: Standard, Small Business, Business. We check conflicts with popular marketplace modules — they often intercept the same events. Load testing: measurements on 10K, 100K, 1M records, profiling via Xdebug for memory leaks and N+1 queries.

Practical Examples

Campaign module for an electronics chain. The built-in sale module discounts did not cover scenarios like "2+1", a gift with purchase over a certain amount, or combined conditions. We built a visual builder: marketers create rules via drag-and-drop without development tickets. Campaign calendar, auto-deactivation via agents, analytics linked to b_sale_order — conversion, average check, usage count. Time to launch a new campaign dropped from two days to half an hour.

Calculator for builders. Parameters (area, materials, number of floors) → formula → preliminary estimate → lead to CRM via CRest::call('crm.lead.add'). Regional coefficients and seasonal markups from a Highload-block, material prices from 1C exchange. The number of target leads increased by a third: clients see a breakdown before calling a manager.

Booking for a hotel chain. Real-time availability via AJAX requests to a custom table vendor_booking_slots, seasonal tariff calculation, synchronization with Booking.com via channel manager API. Room locking on concurrent booking via SELECT ... FOR UPDATE in transactions. Timezones handled via \DateTimeZone — a guest from Vladivostok and a manager from Moscow see the same picture.

We will evaluate your project within one day. Write to us — we'll tell you what is included in turnkey development. Contact us for a consultation on your project. Order a custom module development — get a ready solution with documentation and support.