Bitrix24 is a comprehensive business management platform that combines CRM, project management, communication tools, and business automation features. It provides solutions for sales, marketing, customer service, and team collaboration in a single integrated platform.

Configuring Bitrix24 as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Bitrix24 option from the list of connectors. Click Next and you’ll be prompted to add your access.

1. Add account access

The connector supports two authentication modes:

OAuth (default): Install the Nekt app on your Bitrix24 instance using the install button, provide your Domain URL (e.g. https://yourworkspace.bitrix24.com/), and sign in with Bitrix24 to authorize Nekt.
Webhook: Provide an Incoming webhook URL for your Bitrix24 portal. Check the Bitrix documentation for how to create an incoming webhook and copy its URL.

The following configurations are available:

Authentication mode: oauth (default) or webhook.
Domain URL: The domain URL of your Bitrix24 workspace. Required in OAuth mode; in webhook mode the domain is read from the webhook URL.
Incoming webhook URL: The Bitrix24 incoming webhook URL used for API calls. Required in webhook mode.
Extract deal contacts: (Default: false) When enabled, performs an additional API call per deal to retrieve related contact IDs. Enable only if your deals have multiple clients and you need that list.
Enable deal comments stream: (Default: false) When enabled, the deal_comments stream becomes available. Selecting it triggers one extra API call per deal to fetch comments. Enable only if needed, as it increases extraction time.
Enable deal products stream: (Default: false) When enabled, the deal_products stream becomes available. Selecting it triggers one extra API call per deal to fetch products. Enable only if needed, as it increases extraction time.
Enable deal IDs stream: (Default: false) When enabled, the deal_ids stream becomes available: a full snapshot, on every run, of the IDs of all deals that currently exist in Bitrix24. Use it to detect deals deleted in Bitrix24 (IDs present in the deals table but absent from deal_ids). Only the ID column is requested, so it is much lighter than a full extraction of deals.
Enable quote products stream: (Default: false) When enabled, the quote_products stream becomes available. Selecting it triggers one extra API call per quote to fetch its products. Enable only if needed, as it increases extraction time.
Enable Open Channels sessions stream: (Default: false) When enabled, the imopenlines_sessions stream becomes available: one row per Open Channels (Canais Abertos) conversation session, with the channel it came in on, the operator, the response-time metrics and the CRM record the conversation was attached to.
Enable Open Channels messages stream: (Default: false) When enabled, the imopenlines_messages stream becomes available: the full text of every conversation, one row per message. It lists every session in the replication window before reading its messages, so it makes the extraction considerably longer. Enable only if you need the conversation content.
Operating time threshold: (Default: 200) If Bitrix returns an “operating time” greater than this value (in seconds), the tap will pause for that duration before continuing. Use this to respect rate limits.
Filter deals by funnel ID: (Optional) List of Bitrix deal category IDs (funnels). If set, only deals (and deal IDs) from these categories are extracted. The ID of a funnel can be found in the Bitrix URL when opening the funnel’s kanban page (crm/deal/kanban/category/{ID}). Leave empty to sync all deals.
SPA Column Name Overrides: (Advanced, optional) Map specific Bitrix SPA field codes to exact column names, to control how case-colliding custom fields are separated. Example: {"ufCrm10Fotoprincipal": "ufCrm10Fotoprincipal_2"}. Leave empty to use automatic collision resolution.
Enable BI reports: (Default: false) Enables the Bitrix24 BI Connector report streams (such as Open Channels session statistics). The BI Connector is a separate integration from the webhook and requires its own key.
BI connector key: Bitrix24 BI connector key, generated under CRM -> Analytics -> BI analytics -> Manage keys. Required when ‘Enable BI reports’ is on.
BI reports start date: First day to pull BI report data from on the initial sync.
BI reports window size (days): (Default: 30) Size in days of each BI Connector request window. Smaller windows reduce per-request row counts to stay under plan limits.
BI reports lookback (days): (Default: 30) Number of days re-pulled before the saved bookmark on incremental BI report syncs, to capture updates to recently created sessions.
Open Channels start date: (Advanced, default: 2024-01-01) First day to pull Open Channels sessions and messages from on the initial sync, before any state exists.
Open Channels sessions lookback (days): (Advanced, default: 30) Number of days re-walked before the saved bookmark on incremental syncs of the imopenlines_sessions stream, to capture sessions answered, rated or closed after they were created.
Open Channels messages lookback (days): (Advanced, default: 30) Number of days re-walked before the saved bookmark on incremental syncs of the imopenlines_messages stream. Conversations that keep receiving messages for longer than this stop being refreshed, so raise it if your sessions stay open for weeks.

Scopes that must be included in your webhook (or granted to the Nekt app in OAuth mode) so Nekt can retrieve data:

Scopes for data access

CRM: crm — contacts, companies, deals, deal categories, leads, activities, products, status list, SPA types (and optionally deal comments, deal products, deal IDs, quote products).
Users: user, user_brief, user_basic — user list and profile data.
Company structure: departments — departments.
Telephony: telephony — calls (Voximplant statistics).
Open lines: imopenlines — open line configurations, and optionally Open Channels sessions and the conversation messages themselves. The im scope is not required.

Once you’re done, click Next.

2. Select streams

Choose which data streams you want to sync. Visibility depends on your webhook scopes and on the optional settings above (deal comments, deal products, deal IDs, quote products). You can select entire groups of streams or pick specific ones.

Tip: The stream can be found more easily by typing its name.

If you don’t see a stream you were expecting to find, please check if your access key has the required scope. If that’s not the issue, then it’s probably because we still haven’t implemented it. Feel free to get in touch and request it!

Select the streams and click Next.

3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data), and the type of sync.

Layer: Choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
Folder: A folder can be created inside the selected layer to group all tables being created from this new data source.
Table name: We suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
Sync Type: You can choose between INCREMENTAL and FULL_TABLE.
- Incremental: every time the extraction happens, we’ll get only the new data — which is good if, for example, you want to keep every record ever fetched.
- Full table: every time the extraction happens, we’ll get the current state of the data — which is good if, for example, you don’t want to have deleted data in your catalog.

Once you are done configuring, click Next.

4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Optionally, you can define some additional settings:

Configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here.
Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

Once you are ready, click Next to finalize the setup.

5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

For you to be able to see it on your Catalog, you need at least one successful source run.

Troubleshooting

Issue	Possible cause	Solution
Pipeline fails with `Duplicate custom fields detected in Bitrix` error	Custom fields in Bitrix share codes that differ only by letter case or symbols (e.g., `ufCrm10FotoPrincipal` vs `ufCrm10Fotoprincipal`). Because column names are sanitized before reaching the destination, these fields collapse to the same column name, which causes a failure.	Remove or rename one field of each colliding pair directly in your Bitrix CRM settings, then re-run the pipeline.
The load stops after a custom field starts accepting multiple values	The field changed from single value to list at the source, and the destination column type does not follow automatically.	Run a full sync of the affected stream to recreate the table with the correct type.
Records deleted at the source keep showing up	Bitrix does not expose logical deletion in a way the API can replay.	For deals, enable the `deal_ids` stream, which re-extracts a full snapshot of current deal IDs on every run, and use it to detect deletions. For the other entities, schedule an additional full sync, preferably on the weekend.
A stream does not appear in the list	The matching scope was not granted on the authorization.	Review the scopes listed on this page and re-authorize.

Streams and Fields

Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description. Streams marked optional are only discovered when the corresponding setting is enabled.

Stream	Slug	Description
Activities	`activities`	CRM activities (calls, meetings, tasks, emails).
Activity fields	`activity_fields`	Field definitions/metadata for activities.
Calls	`calls`	Telephony (Voximplant) call statistics. Requires the `telephony` scope.
Companies	`companies`	CRM companies.
Company fields	`company_fields`	Field definitions/metadata for companies.
Contact fields	`contact_fields`	Field definitions/metadata for contacts.
Contacts	`contacts`	CRM contacts.
Deal categories	`deal_categories`	Deal categories (pipelines/funnels).
Deal comments	`deal_comments`	Comments attached to deals. Optional (one API call per deal; enabled via “Enable deal comments stream”).
Deal fields	`deal_fields`	Field definitions/metadata for deals.
Deal IDs	`deal_ids`	Full snapshot of the IDs of every deal currently in Bitrix24, re-extracted on every run; use it to detect deleted deals. Optional (enabled via “Enable deal IDs stream”).
Deal products	`deal_products`	Products (line items) linked to deals. Incremental via the parent deal’s `DATE_MODIFY`. Optional (one API call per deal; enabled via “Enable deal products stream”).
Deal stage history	`deal_stage_history`	History of deal stage (pipeline step) changes.
Deals	`deals`	CRM deals.
Departments	`departments`	Company structure / departments. Requires the `department` scope.
Lead fields	`lead_fields`	Field definitions/metadata for leads.
Lead stage history	`lead_stage_history`	History of lead stage changes.
Leads	`leads`	CRM leads.
Open Channels messages	`imopenlines_messages`	Every message exchanged in Open Channels conversations, one row per message, with the author classified as client, operator or system. Requires the `imopenlines` scope. Optional (enabled via “Enable Open Channels messages stream”).
Open Channels sessions	`imopenlines_sessions`	One row per Open Channels conversation session, with the channel, the operator, the response-time metrics and the linked CRM record. Requires the `imopenlines` scope. Optional (enabled via “Enable Open Channels sessions stream”).
Open lines	`open_lines`	Open Lines (communication channels) configuration. Requires the `imopenlines` scope.
Product	`product`	CRM product catalog.
Product fields	`product_fields`	Field definitions/metadata for products.
Quotes	`quotes`	CRM quotes. Incremental sync via `DATE_MODIFY`.
Quote fields	`quote_fields`	Field definitions/metadata for quotes.
Quote products	`quote_products`	Products (line items) linked to quotes. Incremental via the parent quote’s `DATE_MODIFY`. Optional (one API call per quote; enabled via “Enable quote products stream”).
SPA types	`spa_types`	Smart Process Automation (SPA) entity types, used to discover the dynamic SPA streams.
SPA stage history	`spa_stage_history`	Stage (pipeline step) change history for SPA items. Incremental sync via `CREATED_TIME`.
Status list	`status_list`	CRM status list (deal/lead status options, etc.).
Users	`users`	Bitrix24 users. Requires the `user`, `user_brief` and `user_basic` scopes.
SPA data (dynamic)	`spa_{entityTypeId}`	Dynamic. One data stream per SPA entity type in your portal (e.g. `spa_128`).
SPA fields (dynamic)	`spa_fields_{entityTypeId}`	Dynamic. Field definitions/metadata for each SPA entity type (e.g. `spa_fields_128`).

Fields by stream

Below you’ll find all available data streams from Bitrix24 and their main fields. CRM entity streams (contacts, companies, deals, leads, activities, product) have schemas built dynamically from the Bitrix API, so custom fields (e.g. UF_*) may vary per portal.

activities

Stream for CRM activities (calls, meetings, tasks, etc.). Schema is built from the Bitrix API.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`CREATED`	String	Replication key (incremental sync)
Custom fields	Varies	Additional fields depend on your Bitrix CRM activity configuration

activity_fields

Metadata stream for activity field definitions (types, labels, options).Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`isRequired`, `isReadOnly`, `items` (for list fields), etc.

calls

Stream for telephony (Voximplant) call statistics. Requires scope telephony.Key fields:

Field	Type	Description
`ID`	String	Unique identifier
`CALL_START_DATE`	String	Replication key
`PORTAL_USER_ID`	Integer	ID of the portal user
`PHONE_NUMBER`	String	Phone number
`CALL_DURATION`	Integer	Call duration
`CALL_RECORD_URL`	String	URL to the call recording
`CRM_ENTITY_TYPE`	String	Related CRM entity type
`CRM_ENTITY_ID`	Integer	Related CRM entity ID
`COST`	Number	Cost of the call
`COST_CURRENCY`	String	Currency of the cost

companies

Stream for CRM companies. Schema is built from the Bitrix API.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`DATE_MODIFY`	String	Replication key
Custom fields	Varies	Standard and custom (`UF_*`) company fields from your portal

company_fields

Metadata stream for company field definitions.Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`statusType`, `isRequired`, `items`, `listLabel`, `formLabel`, etc.

contacts

Stream for CRM contacts. Schema is built from the Bitrix API.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`DATE_MODIFY`	String	Replication key
Custom fields	Varies	Standard and custom (`UF_*`) contact fields from your portal

contact_fields

Metadata stream for contact field definitions.Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`statusType`, `isRequired`, `items`, `listLabel`, `formLabel`, etc.

deal_categories

Stream for deal categories (pipelines/funnels). Schema is built from the Bitrix API.Key fields:

Field	Type	Description
`id`	Integer	Unique identifier of the category.
`name`	String	Name of the pipeline/funnel.
`sort`	Integer	Sort order of the category.
`entityTypeId`	Integer	Identifier of the entity type this category belongs to.
`isDefault`	Boolean	Whether this is the default category.
`originId`	String	Origin identifier for external integrations.
`originatorId`	String	Originator identifier for external integrations.

deal_comments

Stream for comments attached to deals. Available only when “Enable deal comments stream” is turned on. One API call per deal.Key fields:

Field	Type	Description
Content data	Varies	Comment content and metadata; structure depends on Bitrix API response.

deal_fields

Metadata stream for deal field definitions.Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`statusType`, `isRequired`, `items`, `listLabel`, `formLabel`, etc.

deal_ids

Full snapshot of the IDs of every deal that currently exists in Bitrix24. Available only when “Enable deal IDs stream” is turned on. Bitrix24 has no deletion flag (a deleted deal goes to the recycle bin and simply disappears from the API), so this stream is re-extracted in full on every run, requesting only the ID column, and can be used to detect deals deleted in Bitrix24 (IDs present in the deals table but absent from deal_ids). It honours the “Filter deals by funnel ID” setting.Key fields:

Field	Type	Description
`ID`	String	Identifier of a deal that currently exists in Bitrix24. Same type as `deals.ID`, so the tables join without casting.

deal_products

Stream for products (line items) linked to deals. Available only when “Enable deal products stream” is turned on. One API call per deal. Supports incremental sync based on the parent deal’s modification date (DEAL_DATE_MODIFY).Key fields:

Field	Type	Description
`ID`	String	Unique identifier of the record.
`OWNER_ID`	String	Identifier of the associated deal.
`OWNER_TYPE`	String	Type of the owner entity.
`PRODUCT_ID`	Integer	Identifier of the associated product.
`PRODUCT_NAME`	String	Name of the product.
`ORIGINAL_PRODUCT_NAME`	String	Original product name from the catalog.
`PRODUCT_DESCRIPTION`	String	Description of the product.
`PRICE`	Number	Monetary value associated with the record.
`PRICE_EXCLUSIVE`	Number	Price excluding tax.
`PRICE_NETTO`	Number	Net price of the product.
`PRICE_BRUTTO`	Number	Gross price of the product.
`PRICE_ACCOUNT`	String	Price in account currency.
`QUANTITY`	Integer	Quantity of the product.
`DISCOUNT_TYPE_ID`	Integer	Identifier of the discount type.
`DISCOUNT_RATE`	Number	Discount rate applied.
`DISCOUNT_SUM`	Number	Discount amount.
`TAX_RATE`	Number	Tax rate applied to the product.
`TAX_INCLUDED`	String	Whether tax is included in the price.
`CUSTOMIZED`	String	Whether the row was customized.
`MEASURE_CODE`	Integer	Code of the measure unit.
`MEASURE_NAME`	String	Name of the measure unit.
`SORT`	Integer	Sort order of the row.
`XML_ID`	String	External identifier for integration.
`TYPE`	Integer	Type classification of the record.
`STORE_ID`	Integer	Identifier of the associated store.
`RESERVE_ID`	Integer	Identifier of the reserve.
`DATE_RESERVE_END`	String	End date of the reservation.
`RESERVE_QUANTITY`	Integer	Reserved quantity.
`DEAL_DATE_MODIFY`	DateTime	Timestamp when the parent deal was last updated; inherited from the parent stream and used as the incremental bookmark.

deals

Stream for CRM deals. Schema is built from the Bitrix API. Optionally can include CONTACT_IDS per deal when “Extract deal contacts” is enabled.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`DATE_MODIFY`	String	Replication key
`CATEGORY_ID`	Integer	Funnel/pipeline category ID
Custom fields	Varies	Standard and custom (`UF_*`) deal fields

deal_stage_history

Stream for deal stage (pipeline step) change history.Key fields:

Field	Type	Description
History data	Varies	Identifiers and timestamps for stage transitions; structure depends on Bitrix API.

departments

Stream for company structure (departments). Requires scope departments.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`NAME`	String	Department name
`SORT`	Integer	Sort order
`PARENT`	Integer	Parent department ID
`UF_HEAD`	Integer	Department head user ID

lead_fields

Metadata stream for lead field definitions.Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`statusType`, `isRequired`, `items`, `listLabel`, `formLabel`, etc.

leads

Stream for CRM leads. Schema is built from the Bitrix API.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`DATE_MODIFY`	String	Replication key
Custom fields	Varies	Standard and custom lead fields from your portal

lead_stage_history

Stream for lead stage change history.Key fields:

Field	Type	Description
History data	Varies	Identifiers and timestamps for stage transitions; structure depends on Bitrix API.

imopenlines_sessions

Stream for Open Channels (Canais Abertos) conversation sessions. One row per session, which is a single conversation segment inside a chat. Requires scope imopenlines, and the “Enable Open Channels sessions stream” setting. Incremental via dateCreate.Key fields:

Field	Type	Description
`id`	Integer	Unique identifier of the session
`configId`	Integer	Identifier of the open line the session belongs to
`source`	String	Connector the conversation came in through, e.g. `whatsapp`, `facebook`, `livechat`
`operatorId`	Integer	Identifier of the assigned operator; `0` when unassigned
`userId`	Integer	Identifier of the client user record created by the connector
`userCode`	String	Connector-side client identifier, stable across sessions with the same client
`chatId`	Integer	Identifier of the chat that holds the session’s messages
`dateCreate`	DateTime	Replication key. Timestamp when the session was opened
`dateClose`	DateTime	Timestamp when the session was closed; null while still open
`dateFirstAnswer`	DateTime	Timestamp of the first answer sent in the session
`dateOperatorAnswer`	DateTime	Timestamp of the first answer sent by a human operator
`status`	String	Session status, e.g. `new`, `answered`, `closed`, `spam`, `paused`
`closeReason`	String	Reason the session was closed, when Bitrix recorded one
`vote`	String	Client satisfaction vote, e.g. `none`, `like`, `dislike`
`voteHead`	Integer	Supervisor rating given to the session
`commentHead`	String	Supervisor comment left on the session
`crmEntityType`	String	Type of CRM record the conversation was attached to: `lead`, `deal`, `contact` or `company`
`crmEntityId`	Integer	Identifier of the attached CRM record
`queueTransfers`	Integer	Number of times the session was transferred between operators or queues
`waitAnswer`	Integer	Seconds the client waited for the first answer
`waitClose`	Integer	Seconds between the last message and the session being closed
`kpiFirstAnswer`	Integer	First-answer KPI outcome; null when no KPI is configured on the line
`messageCount`	Integer	Client and operator messages counted by Bitrix. Excludes system messages, so it reads lower than the row count in `imopenlines_messages`

imopenlines_messages

Stream for the messages exchanged in Open Channels conversations. One row per message, carrying the session context alongside the message itself. Requires scope imopenlines, and the “Enable Open Channels messages stream” setting. Incremental via session_date_create.Message text is landed exactly as Bitrix stores it, BBCode markup included ([b], [USER=23]Name[/USER], [URL=...]). Clean it up in a transformation if you need plain text.Key fields:

Field	Type	Description
`message_id`	String	Unique identifier of the message
`session_id`	Integer	Session the message belongs to. Joins to `imopenlines_sessions.id`
`chat_id`	Integer	Chat holding the session
`message_chat_id`	Integer	Chat identifier as reported on the message itself
`config_id`	Integer	Open line the conversation came in on
`session_source`	String	Connector the conversation came in through
`session_status`	String	Status of the session at extraction time
`session_date_create`	DateTime	Replication key. Creation timestamp of the session
`session_date_close`	DateTime	Timestamp when the session was closed; null while still open
`session_operator_id`	Integer	Operator assigned to the session
`session_user_code`	String	Connector-side client identifier for the conversation
`crm_entity_type`	String	Type of CRM record the conversation was attached to
`crm_entity_id`	Integer	Identifier of the attached CRM record
`date`	DateTime	Timestamp when the message was posted
`text`	String	Message body as Bitrix stores it, BBCode markup included
`text_legacy`	String	Legacy rendering of the same body, where some markup is HTML rather than BBCode
`author_id`	Integer	Author of the message; `0` for messages Bitrix posts itself
`author_name`	String	Display name of the author
`author_first_name`	String	First name of the author
`author_last_name`	String	Last name of the author
`author_work_position`	String	Job title of the author, for staff users who have one
`author_external_auth_id`	String	Authentication source of the author; `imconnector` marks the external client
`author_is_bot`	Boolean	Whether the author is a chatbot
`is_system`	Boolean	Message posted by Bitrix itself, e.g. “conversation started”, “operator accepted the chat”
`is_client`	Boolean	Message sent by the external client
`is_operator`	Boolean	Message sent by a member of staff or a bot
`connector_message_ids`	Array of String	Message identifiers assigned by the external channel, e.g. WhatsApp message ids. Use these to reconcile with the messaging provider
`is_deleted`	Boolean	Whether the message was deleted in Bitrix
`is_edited`	Boolean	Whether the message was edited after being sent
`component_id`	String	Interface component that rendered the message, set on system messages
`system_event_class`	String	CSS class Bitrix tags system messages with, e.g. `bx-messenger-content-item-ol-end` for a session being closed. Useful to classify system events
`files`	Array of Object	Attachments, with `id`, `name`, `type`, `extension`, `size`, `date`, `author_id`, `is_voice_note` and `is_video_note`
`attach`	String (JSON)	Rich attachment blocks rendered under the message, such as the CRM record card Bitrix posts when a deal is linked
`params`	String (JSON)	Remaining message parameters not promoted to their own columns. The set of keys varies widely by message type

open_lines

Stream for Open Lines (communication channels) configuration. Requires scope imopenlines.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`ACTIVE`	Boolean	Whether the line is active
`LINE_NAME`	String	Communication channel name
`CRM`	Boolean	CRM routing flag
`DATE_CREATE`	String	Creation date
`DATE_MODIFY`	String	Modification date
Settings	Varies	Queue, welcome, worktime, KPI and other channel settings

product

Stream for CRM product catalog. Schema is built from the Bitrix API.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`TIMESTAMP_X`	String	Replication key
Custom fields	Varies	Standard and custom product fields from your portal

product_fields

Metadata stream for product field definitions.Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`statusType`, `isRequired`, `items`, `listLabel`, `formLabel`, etc.

quotes

Stream for CRM quotes. Schema is built from the Bitrix API. Supports incremental sync using the DATE_MODIFY replication key.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`DATE_MODIFY`	String	Replication key
Custom fields	Varies	Standard and custom (`UF_*`) quote fields from your portal

quote_fields

Metadata stream for quote field definitions.Key fields:

Field	Type	Description
`id`	String	Field identifier
`type`	String	Field type
`title`	String	Display name
Metadata	Varies	`statusType`, `isRequired`, `isReadOnly`, `isImmutable`, `isMultiple`, `isDynamic`, `isDeprecated`, `items`, `listLabel`, `formLabel`, `filterLabel`, `settings`, `upperName`, etc.

quote_products

Stream for products (line items) linked to quotes. Available only when “Enable quote products stream” is turned on. One API call per quote. Supports incremental sync based on the parent quote’s modification date (QUOTE_DATE_MODIFY).Key fields:

Field	Type	Description
`ID`	String	Unique identifier of the record.
`OWNER_ID`	String	Identifier of the associated quote.
`OWNER_TYPE`	String	Type of the owner entity.
`PRODUCT_ID`	Integer	Identifier of the associated product.
`PRODUCT_NAME`	String	Name of the product.
`ORIGINAL_PRODUCT_NAME`	String	Original product name from the catalog.
`PRODUCT_DESCRIPTION`	String	Description of the product.
`PRICE`	Number	Monetary value associated with the record.
`PRICE_EXCLUSIVE`	Number	Price excluding tax.
`PRICE_NETTO`	Number	Net price of the product.
`PRICE_BRUTTO`	Number	Gross price of the product.
`PRICE_ACCOUNT`	String	Price in account currency.
`QUANTITY`	Integer	Quantity of the product.
`DISCOUNT_TYPE_ID`	Integer	Identifier of the discount type.
`DISCOUNT_RATE`	Number	Discount rate applied.
`DISCOUNT_SUM`	Number	Discount amount.
`TAX_RATE`	Number	Tax rate applied to the product.
`TAX_INCLUDED`	String	Whether tax is included in the price.
`CUSTOMIZED`	String	Whether the row was customized.
`MEASURE_CODE`	Integer	Code of the measure unit.
`MEASURE_NAME`	String	Name of the measure unit.
`SORT`	Integer	Sort order of the row.
`XML_ID`	String	External identifier for integration.
`TYPE`	Integer	Type classification of the record.
`STORE_ID`	Integer	Identifier of the associated store.
`RESERVE_ID`	Integer	Identifier of the reserve.
`DATE_RESERVE_END`	String	End date of the reservation.
`RESERVE_QUANTITY`	Integer	Reserved quantity.
`QUOTE_DATE_MODIFY`	DateTime	Timestamp when the parent quote was last updated; inherited from the parent stream and used as the incremental bookmark.

spa_types

Stream for SPA (Smart Process Automation) entity types. Used to discover dynamic SPA streams.Key fields:

Field	Type	Description
Identifiers	Varies	Entity type identifiers used to build `spa_{entityTypeId}` and `spa_fields_{entityTypeId}` streams.

spa_{entityTypeId} / spa_fields_{entityTypeId}

Dynamic streams created per SPA entity type in your Bitrix portal (e.g. spa_128, spa_fields_128). Data and field metadata for each SPA entity type; structure depends on your Bitrix configuration.

status_list

Stream for CRM status list (e.g. deal/lead status options).Key fields:

Field	Type	Description
Status data	Varies	Status identifiers, labels and configuration; structure depends on Bitrix API.

users

Stream for Bitrix24 users. Requires scopes user, user_brief, user_basic.Key fields:

Field	Type	Description
`ID`	Integer	Unique identifier
`NAME`	String	First name
`LAST_NAME`	String	Last name
`EMAIL`	String	Email address
`ACTIVE`	Boolean	Is user active
`LAST_LOGIN`	String	Last login date
`DATE_REGISTER`	String	Registration date
`WORK_POSITION`	String	Job title
`UF_DEPARTMENT`	Array	Department IDs
Profile fields	Varies	`PERSONAL_`, `WORK_` and other profile fields

SPA Stage History

Stream containing the stage history records for Smart Process Automations (SPAs). Incremental sync is supported using CREATED_TIME.Key fields:

Field	Type	Description
`ID`	String	Unique identifier of the record.
`TYPE_ID`	String	Type classification of the record.
`OWNER_ID`	String	Identifier of the associated SPA item.
`CREATED_TIME`	DateTime	Timestamp when the record was created.
`CATEGORY_ID`	String	Identifier of the associated category (funnel).
`STAGE_SEMANTIC_ID`	String	Semantic identifier of the stage.
`STAGE_ID`	String	Current stage of the record.

Data Model

The following diagram illustrates the relationships between the core data streams in Bitrix24. CRM entities relate as follows: Contacts and Companies are standalone; Deals and Leads can be linked to contacts and companies. Deals are organized by Deal Categories (funnels/pipelines). Activities can be attached to deals, contacts, and other entities. product is the catalog; deal_products links products to deals. Users and departments describe your organization; calls and open_lines are telephony and communication data. Field streams (*_fields) describe the schema of their entity (contact, company, deal, lead, activity, product, SPA).

BI Connector streams

Below you’ll find the specific data streams available when using the BI Connector in Bitrix24 (ensure Enable BI reports is turned on). The connector also fetches standard CRM and organizational streams via the outbound webhook (documented above).

Open Channels Session Stats (imopenlines_session_stats)

Open Channels dialog statistics from the Bitrix24 BI Connector. It exposes one row per Open Channels session (dialog) with pre-computed SLA metrics: response times, dialog duration, timestamps, operator, channel and status.

Field	Type	Description
`ID`	Integer	Unique identifier of the Open Channels session (dialog).
`MODE`	String	Session direction, e.g. ‘Entrada’ for inbound.
`STATUS`	String	Human-readable session status, e.g. ‘Fechado’, ‘Spam’.
`SPAM`	String	Spam flag, ‘Y’ if the session was marked as spam, otherwise ‘N’.
`SOURCE`	String	Source channel of the session, e.g. ‘whatsapp’, ‘facebook’, ‘fbinstagramdirect’, ‘facebookcomments’.
`CONFIG_ID`	Integer	Identifier of the open line (channel configuration) the session belongs to.
`CONFIG_NAME`	String	Name of the open line the session belongs to.
`CONFIG`	String	Open line label prefixed with its id, e.g. ‘[4] Instagram’.
`CLIENT_ID`	Integer	Identifier of the client (contact) in the conversation.
`CLIENT_NAME`	String	Display name of the client in the conversation.
`CLIENT`	String	Client label prefixed with its id, e.g. ‘[26] Guest’.
`OPERATOR_ID`	Integer	Identifier of the assigned operator; 0 when no operator was assigned.

Implementation Notes

Optional streams: deal_comments and deal_products appear only when enabled in the source configuration and add one API call per deal; quote_products appears only when enabled and adds one API call per quote; deal_ids appears only when enabled and is a lightweight ID-only snapshot; imopenlines_sessions and imopenlines_messages appear only when enabled and read the Open Channels conversation history. Use only if needed.
Product streams are incremental through their parent: deal_products and quote_products have no modification date of their own, so they inherit the parent’s DATE_MODIFY as DEAL_DATE_MODIFY / QUOTE_DATE_MODIFY and use it as the replication key. Only products of deals/quotes modified since the last run are re-fetched.
Detecting deleted deals: Bitrix24 does not expose a deletion flag, so the incremental deals stream never learns about deals sent to the recycle bin. Enable the deal_ids stream and compare it with your deals table: any ID present in deals but absent from the latest deal_ids snapshot was deleted in Bitrix24.
Deal filtering: Use “Filter deals by funnel ID” to sync only specific funnels and reduce volume. The filter applies to both deals and deal_ids.
Rate limits: If Bitrix returns high “operating time” values, the tap pauses automatically; you can adjust “Operating time threshold” if needed.
SPA streams: spa_types is synced first; then one spa_{id} and one spa_fields_{id} stream per SPA entity type in your portal.
Connection resilience: Schema discovery includes connection pooling and an automatic retry mechanism with exponential backoff (up to 5 attempts). This improves stability when dealing with temporary network issues or API timeouts during the initialization phase.
SPA custom field collisions: Bitrix24 Smart Process Automations can return custom fields whose codes differ only by letter case (e.g., ufCrm10FotoPrincipal vs ufCrm10Fotoprincipal). To avoid data collapsing into a single column, the connector preserves the original column names exactly as returned by Bitrix and automatically resolves collisions by appending a numeric suffix (e.g., _2, _3) to the overlapping fields. If you need to enforce a specific mapping without changing your Bitrix24 setup, pin the names using the SPA Column Name Overrides setting.

Open Channels conversations

The imopenlines_sessions and imopenlines_messages streams need only the imopenlines scope that the connector already asks for. The im scope is not involved.

How the messages are fetched: Bitrix returns a session’s entire message history in one call, but takes one session at a time. Rather than one request per session, the connector lists the sessions in the replication window and then packs 50 history calls into each batched request, which keeps the extraction fast and well inside Bitrix’s operating-time budget.
Both streams replicate on the session’s creation timestamp: Messages cannot bookmark on their own timestamp, because a session is fetched whole or not at all. That is why imopenlines_messages uses session_date_create as its replication key.
Long-running conversations: A conversation that keeps receiving messages for longer than the lookback stops being refreshed. Raise Open Channels messages lookback (days) on portals where sessions stay open for weeks.
Row counts do not match messageCount: The messageCount on a session counts only client and operator messages, so it reads lower than the number of imopenlines_messages rows for that session, which also include Bitrix’s own system messages (“conversation started”, “operator accepted the chat”, “deal attached to the conversation”).
Telling clients from operators: Use the is_client, is_operator and is_system flags rather than trying to infer it from the author id. They are derived at extraction time from information Bitrix only returns alongside the messages.
Attachments: File names, types and sizes are landed, but download URLs are not. Bitrix signs them with a short-lived token that would already be expired by the time the table is read.
Message text is raw: Bodies keep their BBCode markup. Strip it in a transformation if you need plain text.
Relationship with imopenlines_session_stats: Both describe Open Channels sessions. imopenlines_sessions comes from the REST API, needs no BI connector key, and carries the chat and CRM record identifiers; imopenlines_session_stats comes from the BI Connector and carries Bitrix’s pre-computed SLA metrics. Use the first when you need to join conversations to the CRM, the second when you need the ready-made report figures.

BI Connector Replication & Data Quirks

When utilizing the BI Connector to extract reports like imopenlines_session_stats, be aware of the following behaviors and quirks:

Incremental Syncs on DATE_CREATE: The BI dataset has no DATE_MODIFY column, so DATE_CREATE is used as the replication key.
Mutable Sessions: A session created today might be answered or closed days/weeks later, which backfills its stats (e.g. TIME_*, DATE_*). The primary key is ID, and downstream merges should perform an upsert. The bi_reports_lookback_days configuration handles re-pulling recent sessions to capture late updates.
Timestamps: All timestamps are portal-local (e.g. YYYY-MM-DD HH:MM:SS in the account’s configured timezone) and are landed as-is without timezone conversions.
String replication key: Because BI datasets expose naive, portal-local timestamp strings, the replication key is landed unchanged as a string type rather than a timestamp type. The connector safely parses the raw bookmark value internally to calculate the proper lookback windows without causing timestamp validation errors, ensuring reliable incremental syncs for BI reports.
Inflated Response Times: Unanswered sessions will show constantly accruing TIME_* metrics while a client waits. Filter on answered status states before computing SLA aggregates.
No Operator on Certain Channels: Sessions coming from Facebook or Instagram comments might register an OPERATOR_ID of 0 with a null operator name.

Skills for agents

Download Bitrix24 skills file

Bitrix24 connector documentation as plain markdown, for use in AI agent contexts.

Documentation

Get started

Context

Activate

Workspace

Resources

Bitrix24 as a data source

Configuring Bitrix24 as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Troubleshooting

Streams and Fields

Available streams

Fields by stream

Data Model

BI Connector streams

Implementation Notes

Open Channels conversations

BI Connector Replication & Data Quirks

Skills for agents

Download Bitrix24 skills file

​Configuring Bitrix24 as a Source

​1. Add account access

​2. Select streams

​3. Configure data streams

​4. Configure data source

​5. Check your new source

​Troubleshooting

​Streams and Fields

​Available streams

​Fields by stream

​Data Model

​BI Connector streams

​Implementation Notes

​Open Channels conversations

​BI Connector Replication & Data Quirks

​Skills for agents

Download Bitrix24 skills file

Configuring Bitrix24 as a Source

1. Add account access

2. Select streams

3. Configure data streams

4. Configure data source

5. Check your new source

Troubleshooting

Streams and Fields

Available streams

Fields by stream

Data Model

BI Connector streams

Implementation Notes

Open Channels conversations

BI Connector Replication & Data Quirks

Skills for agents