BIconnector: Overview of Methods
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.
BIconnector is a Bitrix24 module that provides methods for connecting external data sources and adapting them for the "Analyst Workspace" section.
In the BIconnector section, there are three groups of methods available: connectors, sources, and datasets. They form a unified workflow for working with data, from setting up the connection to the external service to obtaining a dataset for reporting.
Quick navigation: all methods
User documentation: BI Builder: Analytics hub
Methods only work in the context of the application.
Connectors
A connector defines the rules for integration with an external system. It specifies which endpoints to use to check access, retrieve table structures, and load data. The connector also indicates which authorization parameters need to be requested from the source.
The connector does not store a connection to a specific database or API. It acts as a template that can be reused for multiple sources of the same type. For example, a single MySQL connector can connect to several different MySQL databases.
To work with connectors, use the methods biconnector.connector.*.
Sources
A source is a working connection created based on a connector.
The source is linked to the connector via connectorId and stores specific values for connection parameters: URL, login, password, and other settings described in the connector. This allows one connector to be used to create multiple sources with different parameters, such as for test and production databases.
To work with sources, use the methods biconnector.source.*.
Datasets
A dataset is a description of the data set that is transferred from the source to the "Analyst Workspace."
The dataset is linked to the source via sourceId and defines the data structure for analytics: which fields are available, their types, and how the data can be requested. From one source, separate datasets can be created for use in different reports.
To work with datasets, use the methods biconnector.dataset.*.
User Documentation
Getting Started
- Create a connector using the method biconnector.connector.add to set the integration parameters and the URL of the external endpoints.
- Create a source using the method biconnector.source.add and pass the
connectorIdof the desired connector. - Create a dataset using the method biconnector.dataset.add, then configure its fields via biconnector.dataset.fields.update.
Verification and Debugging
To check the current structure at each level, use the *.fields methods:
- biconnector.connector.fields — which fields can be passed to the connector
- biconnector.source.fields — which fields are expected for the source
- biconnector.dataset.fields — description of the dataset fields
User Documentation
Overview of Methods
Scope:
biconnectorWho can execute methods: a user with access to the "Analyst Workspace" section
Connectors
|
Method |
Description |
|
Adds a new connector |
|
|
Updates an existing connector |
|
|
Retrieves information about the connector |
|
|
Retrieves a list of available connectors |
|
|
Deletes a connector |
|
|
Retrieves the description of the connector fields |
Sources
|
Method |
Description |
|
Adds a new source |
|
|
Updates an existing source |
|
|
Retrieves information about the source |
|
|
Retrieves a list of available sources |
|
|
Deletes a source |
|
|
Retrieves the description of the source fields |
Datasets
|
Method |
Description |
|
Adds a new dataset |
|
|
Updates an existing dataset |
|
|
Retrieves information about the dataset |
|
|
Retrieves a list of available datasets |
|
|
Deletes a dataset |
|
|
Retrieves the description of the dataset fields |
|
|
Updates the fields of the dataset |