Create Connector biconnector.connector.add

Scope: biconnector

Who can execute the method: user with access to the "Analyst's workspace" section

The method biconnector.connector.add creates a new connector that allows integrating external data sources into Bitrix24.

Method Parameters

Required parameters are marked with *

Name
type

Description

fields*
object

An object containing data to create a new connector. The object format:

{
            "field_1": "value_1",
            "field_2": "value_2",
            ...,
            "field_n": "value_n"
        }

field_n — field name
value_n — field value

Detailed description below

Parameter fields

Name `type`	Description
title* `string`	Connector name
logo* `string`	Connector logo. Can be provided as a link to an image or a base64 formatted string, for example `data:image/svg+xml;base64,PHN2ZyB3...`
description `string`	Connector description
urlCheck* `string`	Connector endpoint for availability check, (detailed description)
urlTableList* `string`	Connector endpoint for retrieving the list of tables, (detailed description)
urlTableDescription* `string`	Connector endpoint for retrieving the description of a specific table, (detailed description)
urlData* `string`	Connector endpoint for retrieving data from the selected table, (detailed description)
settings* `array`	List of connection parameters, (detailed description)
sort `int`	Connector sorting parameter. Default value is `100`

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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
                 }
                 }' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/biconnector.connector.add

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{
                 "fields": {
                     "title": "SUPER REST CONNECTOR",
                     "logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1zbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+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

try
        {
        	const response = await $b24.callMethod(
        		'biconnector.connector.add',
        		{
        			fields: {
        				"title": "SUPER REST CONNECTOR",
        				"logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1zbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+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
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result.data());
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'biconnector.connector.add',
                    [
                        'fields' => [
                            "title"               => "SUPER REST CONNECTOR",
                            "logo"                => "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1zbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+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();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding connector: ' . $e->getMessage();
        }

BX24.callMethod(
            'biconnector.connector.add',
            {
                fields: {
                    "title": "SUPER REST CONNECTOR",
                    "logo": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1zbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+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) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data());
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
            'biconnector.connector.add',
            [
                'fields' => [
                    'title' => 'SUPER REST CONNECTOR',
                    'logo' => 'data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjIiIGhlaWdodD0iMjIiIHZpZXdCb3g9IjAgMCAyMiAyMiIgZmlsbD0ibm9uZSIgeG1zbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KCTxjaXJjbGUgY3g9IjExIiBjeT0iMTEiIHI9IjEwIiBmaWxsPSIjRkYzQjNCIiAvPgoJPHRleHQgeD0iMTEiIHk9IjEzIiBmb250LWZhbWlseT0iQXJpYWwsIHNhbnMtc2VyaWYiIGZvbnQtc2l6ZT0iNiIgZmlsbD0iI0ZGRkZGRiIgdGV4dC1hbmNob3I9Im1pZGRsZSIgZm9udC13ZWlnaHQ9ImJvbGQiPlJFU1Q8L3RleHQ+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
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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 `type`	Description
result `integer`	Root element of the response, contains the identifier of the created connector
time `time`	Information about the request execution time

Error Handling

HTTP status: 200

{
            "error": "VALIDATION_FIELDS_NOT_PROVIDED",
            "error_description": "Fields not provided."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`VALIDATION_FIELDS_NOT_PROVIDED`	Fields not provided	Fields were not passed in the request
`VALIDATION_UNKNOWN_PARAMETERS`	Unknown parameters: #LIST_OF_PARAMS#	Unknown parameters detected: list
`VALIDATION_REQUIRED_FIELD_MISSING`	Field "#TITLE#" is required.	Required field #TITLE# was not provided
`VALIDATION_READ_ONLY_FIELD`	Field "#TITLE#" is read only.	Field #TITLE# is read-only and cannot be modified
`VALIDATION_IMMUTABLE_FIELD`	Field "#TITLE#" is immutable.	Field #TITLE# is immutable
`VALIDATION_INVALID_FIELD_TYPE`	Field "#TITLE#" must be of type #TYPE#.	Field #TITLE# must be of type #TYPE#
`VALIDATION_SETTINGS_MISSING_REQUIRED_FIELDS`	Settings must include "type", "name" and "code" fields.	Settings must include `type`, `name`, and `code` fields
`VALIDATION_SETTINGS_NAME_TOO_LONG`	Parameter "name" must be less than 512 characters.	The value of the parameter `name` must not exceed 512 characters
`VALIDATION_SETTINGS_CODE_TOO_LONG`	Parameter "code" must be less than 512 characters.	The value of the parameter `code` must not exceed 512 characters
`VALIDATION_SETTINGS_INVALID_TYPE`	Parameter "type" is not correct.	Invalid value for parameter `type`

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of methods

Update connector

Create Connector biconnector.connector.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning