Create Source biconnector.source.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 with access to the Analytics hub section
The biconnector.source.add method creates a new data source linked to a connector.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object containing data to create a new source. The object format is:
|
Parameter fields
|
Name |
Description |
|
title* |
Source name |
|
description |
Source description |
|
active |
Source activity. |
|
connectorId* |
Connector identifier, can be obtained using the methods biconnector.connector.list or biconnector.connector.add |
|
settings* |
A list of parameters for authorization, passed as an object where the key is the |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"CRM Source","description":"CRM data source","connectorId":123,"settings":{"login":"admin","password":"qwerty"}}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.source.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"title":"CRM Source","description":"CRM data source","connectorId":123,"settings":{"login":"admin","password":"qwerty"}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/biconnector.source.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type SourceAddResult = {
id: number
}
try {
const response = await $b24.actions.v2.call.make<SourceAddResult>({
method: 'biconnector.source.add',
params: {
fields: {
title: 'CRM Source',
description: 'CRM data source',
connectorId: 123,
settings: {
login: 'admin',
password: 'qwerty',
},
},
},
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
console.info('Created source 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 addSource() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'biconnector.source.add',
params: {
fields: {
title: 'CRM Source',
description: 'CRM data source',
connectorId: 123,
settings: {
login: 'admin',
password: 'qwerty',
},
},
},
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
console.info('Created source id:', result.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addSource)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.biconnector.source.add(
fields={
"title": "CRM Source",
"description": "CRM data source",
"connectorId": 123,
"settings": {
"login": "admin",
"password": "qwerty",
},
},
).response
result = bitrix_response.result
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.source.add',
[
'fields' => [
"title" => "CRM Source",
"description" => "CRM data source",
"connectorId" => 123,
"settings" => [
"login" => "admin",
"password" => "qwerty"
]
]
]
);
$result = $response
->getResponseData()
->getResult();
if ($response->getError()) {
error_log($response->getError());
echo 'Error: ' . $response->getError();
} else {
echo 'Success: ' . print_r($result, true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding source: ' . $e->getMessage();
}
BX24.callMethod(
'biconnector.source.add',
{
fields: {
"title": "CRM Source",
"description": "CRM data source",
"connectorId": 123,
"settings": {
"login": "admin",
"password": "qwerty"
}
}
},
(result) => {
result.error() ? console.error(result.error()) : console.info(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'biconnector.source.add',
[
'fields' => [
'title' => 'CRM Source',
'description' => 'CRM data source',
'connectorId' => 123,
'settings' => [
'login' => 'admin',
'password' => 'qwerty'
]
]
]
);
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.source.add", b24.Params{
"fields": b24.Params{
"title": "CRM Source",
"description": "CRM data source",
"connectorId": 123,
"settings": b24.Params{
"login": "admin",
"password": "qwerty",
},
},
})
if err != nil {
return fmt.Errorf("biconnector.source.add: %w", err)
}
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": 7
},
"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. Contains the |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 200
{
"error": "VALIDATION_FIELDS_NOT_PROVIDED",
"error_description": "Fields not provided."
}
|
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 |
|
|
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#" is immutable. |
Field #TITLE# is immutable |
|
|
Field "#TITLE#" must be of type #TYPE#. |
Field #TITLE# must be of type #TYPE# |
|
|
Connector was not found. |
Connector not found |
|
|
Cannot create connection. |
Error creating connection |
|
|
Cannot update connection. |
Error updating connection |
|
|
Cannot delete source. Delete all related datasets first. |
Cannot delete source while related datasets exist |
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 |