event.bind
Зарегистрировать новый обработчик события
Описание
Метод event.bind регистрирует новый обработчик события.
Метод работает только в контексте авторизации приложения. Может работать как при авторизации под пользователем с правами администрирования портала, так и под обычным пользователем. Метод для пользователя без прав администратора доступен с ограничениями:
- Офлайн-события недоступны, попытка установки будет порождать исключение
- События устанавливаются от имени текущего пользователя (см. описание параметра
auth_type). Явное указаниеauth_type, отличного отIDтекущего пользователя, также будет порождать исключение
Поскольку запросы будут идти с серверов Битрикс, то любой URL должен быть доступен для GET/POST запросов извне.
Интерфейс для данного метода — BX24.callBind.
При удалении и обновлении приложения его действия будут удаляться. Поэтому в инсталляторе каждой версии нужно их выставлять с нуля.
События не будут отправляться в приложение, пока установка не завершена. Проверьте установку приложения
Параметры
event
string
обязательный
Имя события
handler
string
обязательный
Ссылка на обработчик события
auth_type
integer
необязательный
Идентификатор пользователя, под которым авторизуется обработчик события. По умолчанию будет использоваться авторизация пользователя, действия которого привели к срабатыванию события
event_type
string
необязательный
Значения: ``online|offline`. По умолчанию event_type=online, и поведение метода не меняется. Если вызывается event_type=offline`, то метод работает с офлайн-событиями
auth_connector
string
необязательный
Ключ источника. Параметр предназначен для офлайн-событий. Позволяет исключать ложные срабатывания событий
options
object
необязательный
Дополнительные настройки регистрируемого события. Набор полей зависит от события.
Для события ONOFFLINEEVENT поддерживается параметр minTimeout — минимальный интервал между уведомлениями в секундах. По умолчанию 1. Подробнее в статье onOfflineEvent
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"event": "ONCRMLEADADD",
"handler": "https://www.my-domain.ru/handler/",
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/event.bind
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'event.bind',
params: {
event: 'ONCRMLEADADD',
handler: 'https://www.my-domain.ru/handler/',
auth_type: 15,
},
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('Handler registered:', result)
}
} 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 bindEvent() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'event.bind',
params: {
event: 'ONCRMLEADADD',
handler: 'https://www.my-domain.ru/handler/',
auth_type: 15,
},
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('Handler registered:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', bindEvent)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.event.bind(
event="ONCRMLEADADD",
handler="https://www.my-domain.com/handler/",
auth_type=15,
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
require_once('crest.php');
$result = CRest::call(
'event.bind',
[
'event' => 'ONCRMLEADADD',
'handler' => 'https://www.my-domain.ru/handler/',
'auth_type' => 15
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "event.bind", b24.Params{
"event": "ONCRMLEADADD",
"handler": "https://www.my-domain.ru/handler/",
})
if err != nil {
return fmt.Errorf("event.bind: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1721296536.908506,
"finish": 1721296537.007365,
"duration": 0.09885907173156738,
"processing": 0.03251290321350098,
"date_start": "2024-07-18T11:55:36+02:00",
"date_finish": "2024-07-18T11:55:37+02:00",
"operating": 0
}
}
Возвращаемые данные
result
boolean
Успешность выполнения
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error":"ERROR_EVENT_NOT_FOUND",
"error_description":"Event not found"
}
| Код | Описание | Значение |
|---|---|---|
400 |
ERROR_EVENT_NOT_FOUND |
Event not found |
403 |
ACCESS_DENIED |
Access denied! Offline events binding requires administrator access rights |
403 |
ACCESS_DENIED |
Access denied! Event binding with AUTH_TYPE requires administrator access rights |

