Create Connector biconnector.connector.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
biconnectorWho can execute the method: A user who has both the "Access to BI Builder" and "Access to Analytics Hub" permissions
The biconnector.connector.add method creates a new connector.
The method works only in the context of an application. The created connector is visible only to this application: it is not available to other applications. When called via a webhook, the method returns the ACCESS_DENIED error
A connector describes only the endpoint addresses and the list of authorization parameters — on its own it does not deliver data. To retrieve data, create a source with the biconnector.source.add method after the connector and pass the connector id in it.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object containing data to create a new connector. The object format:
|
Parameter fields
|
Name |
Description |
|
title* |
Connector name, maximum length is 512 characters |
|
logo* |
Connector logo. Can be provided as a link to an image or a base64 formatted string, for example |
|
description |
Connector description |
|
urlCheck* |
Connector endpoint for availability check, maximum length is 2048 characters, (detailed description) |
|
urlTableList* |
Connector endpoint for retrieving the list of tables, maximum length is 2048 characters, (detailed description) |
|
urlTableDescription* |
Connector endpoint for retrieving the description of a specific table, maximum length is 2048 characters, (detailed description) |
|
urlData* |
Connector endpoint for retrieving data from the selected table, maximum length is 2048 characters, (detailed description) |
|
settings* |
Array of connection parameters: the codes and names of the fields whose values the user fills in when creating a source (detailed description) |
|
supportMapping |
Support for mapping the table fields to the fields of the external system. The default value is The value is checked with a strict comparison against the boolean type, so it does not pass in a request of the |
|
sourceCode |
String code of the external system, maximum length is 64 characters |
|
sort |
Connector sorting parameter. Default value is |
Parameter settings
Each element of the settings array is an object with three required fields.
|
Name |
Description |
|
code* |
Parameter code. The parameter goes to the external system under this name inside the |
|
name* |
Parameter name that the user sees in the Analytics hub section. Maximum length is 512 characters |
|
type* |
Parameter type that determines the input field in the interface. Allowed values: |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"fields": {
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Login",
"type": "STRING",
"code": "login"
},
{
"name": "Password",
"type": "STRING",
"code": "password"
}
],
"sort": 100
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/biconnector.connector.add
// 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
// Methods of this section put errors inside result and answer with HTTP 200
type BiconnectorError = {
error: {
error: string
error_description: string
}
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type ConnectorAddResult = {
id: number
}
try {
const response = await $b24.actions.v2.call.make<ConnectorAddResult | BiconnectorError>({
method: 'biconnector.connector.add',
params: {
fields: {
title: 'SUPER REST CONNECTOR',
logo: 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==',
description: 'Connector with token',
urlCheck: 'http://example.com/api/check',
urlTableList: 'http://example.com/api/table_list',
urlTableDescription: 'http://example.com/api/table_description',
urlData: 'http://example.com/api/data',
settings: [
{
name: 'Login',
type: 'STRING',
code: 'login',
},
{
name: 'Password',
type: 'STRING',
code: 'password',
},
],
sort: 100,
},
},
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
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if ('error' in result) {
console.error(result.error.error, result.error.error_description)
} else {
console.info('Created connector ID:', result.id)
}
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 addConnector() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.connector.add',
params: {
fields: {
title: 'SUPER REST CONNECTOR',
logo: 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==',
description: 'Connector with token',
urlCheck: 'http://example.com/api/check',
urlTableList: 'http://example.com/api/table_list',
urlTableDescription: 'http://example.com/api/table_description',
urlData: 'http://example.com/api/data',
settings: [
{
name: 'Login',
type: 'STRING',
code: 'login',
},
{
name: 'Password',
type: 'STRING',
code: 'password',
},
],
sort: 100,
},
},
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
// The SDK sees HTTP 200 as success, so check the error inside result yourself
if (result && result.error) {
console.error(result.error.error, result.error.error_description)
return
}
console.info('Created connector ID:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addConnector)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.connector.add(
fields={
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Login",
"type": "STRING",
"code": "login",
},
{
"name": "Password",
"type": "STRING",
"code": "password",
},
],
"sort": 100,
},
).response
result = bitrix_response.result
# Methods of this section put errors inside result and answer with HTTP 200
if isinstance(result, dict) and "error" in result:
print(
"BIconnector error",
f"error: {result['error']['error']}",
f"error_description: {result['error']['error_description']}",
sep="\n",
)
else:
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'biconnector.connector.add',
[
'fields' => [
"title" => "SUPER REST CONNECTOR",
"logo" => "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description" => "Connector with token",
"urlCheck" => "http://example.com/api/check",
"urlTableList" => "http://example.com/api/table_list",
"urlTableDescription" => "http://example.com/api/table_description",
"urlData" => "http://example.com/api/data",
"settings" => [
[
"name" => "Login",
"type" => "STRING",
"code" => "login"
],
[
"name" => "Password",
"type" => "STRING",
"code" => "password"
]
],
"sort" => 100
],
]
);
$result = $response
->getResponseData()
->getResult();
$data = $result;
// Methods of this section put errors inside result and answer with HTTP 200
if (isset($data['error'])) {
echo 'BIconnector error: ' . $data['error']['error'] . ': ' . $data['error']['error_description'];
} else {
echo 'Success: ' . print_r($data, true);
}
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'biconnector.connector.add',
{
fields: {
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": [
{
"name": "Login",
"type": "STRING",
"code": "login"
},
{
"name": "Password",
"type": "STRING",
"code": "password"
}
],
"sort": 100
},
},
(result) => {
if (result.error()) {
console.error(result.error());
return;
}
const data = result.data();
// Methods of this section put errors inside result and answer with HTTP 200
if (data && data.error) {
console.error(data.error.error, data.error.error_description);
return;
}
console.info(data);
},
);
require_once('crest.php');
$result = CRest::call(
'biconnector.connector.add',
[
'fields' => [
'title' => 'SUPER REST CONNECTOR',
'logo' => 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==',
'description' => 'Connector with token',
'urlCheck' => 'http://example.com/api/check',
'urlTableList' => 'http://example.com/api/table_list',
'urlTableDescription' => 'http://example.com/api/table_description',
'urlData' => 'http://example.com/api/data',
'settings' => [
[
'name' => 'Login',
'type' => 'STRING',
'code' => 'login'
],
[
'name' => 'Password',
'type' => 'STRING',
'code' => 'password'
]
],
'sort' => 100
]
]
);
// Methods of this section put errors inside result and answer with HTTP 200
if (isset($result['result']['error'])) {
echo 'BIconnector error: ' . $result['result']['error']['error']
. ': ' . $result['result']['error']['error_description'];
} else {
echo '<PRE>';
print_r($result);
echo '</PRE>';
}
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "biconnector.connector.add", b24.Params{
"fields": b24.Params{
"title": "SUPER REST CONNECTOR",
"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+Cjwvc3ZnPg==",
"description": "Connector with token",
"urlCheck": "http://example.com/api/check",
"urlTableList": "http://example.com/api/table_list",
"urlTableDescription": "http://example.com/api/table_description",
"urlData": "http://example.com/api/data",
"settings": []b24.Params{
{
"name": "Login",
"type": "STRING",
"code": "login",
},
{
"name": "Password",
"type": "STRING",
"code": "password",
},
},
"sort": 100,
},
})
if err != nil {
return fmt.Errorf("biconnector.connector.add: %w", err)
}
// Methods of this section put errors inside result and answer with HTTP 200.
var apiErr struct {
Error *struct {
Error string `json:"error"`
Description string `json:"error_description"`
} `json:"error"`
}
if err := json.Unmarshal(res.Result, &apiErr); err == nil && apiErr.Error != nil {
return fmt.Errorf("biconnector.connector.add: %s: %s", apiErr.Error.Error, apiErr.Error.Description)
}
var item struct {
ID b24.ID `json:"id"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID)
Response Handling
HTTP status: 200
{
"result": {
"id": 4
},
"time": {
"start": 1725013197.635808,
"finish": 1725013198.580873,
"duration": 0.9450650215148926,
"processing": 0.6822988986968994,
"date_start": "2024-08-30T12:19:57+02:00",
"date_finish": "2024-08-30T12:19:58+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
The result object
|
Name |
Description |
|
id |
Identifier of the created connector. Pass it in the |
Error Handling
HTTP status: 200
{
"result": {
"error": {
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
}
}
The method returns an error inside the result field and with HTTP status 200. Check result.error: the SDK wrappers parse only the top level of the response and treat such an error as a success
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
Value |
|
|
Access denied. |
One of the two permissions is missing, BI Builder external data sources are not available on this Bitrix24, or the method was called via a webhook or outside the application context |
|
|
Fields not provided. |
Fields were not passed in the request |
|
|
Unknown parameters: #LIST_OF_PARAMS# |
Unknown parameters detected: list |
|
|
Field "#TITLE#" is required. |
Required field #TITLE# was not provided |
|
|
Field "#TITLE#" is read only. |
Field #TITLE# is read-only and cannot be modified |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Field #TITLE# must be of type #TYPE# |
|
|
Settings must include "type", "name" and "code" fields. |
Settings must include |
|
|
Parameter "name" must be less than 512 characters. |
The value of the parameter |
|
|
Parameter "code" must be less than 512 characters. |
The value of the parameter |
|
|
Parameter "type" is not correct. |
Invalid value for parameter |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |