Вернуть параметры действию или роботу bizproc.event.send

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: bizproc

Кто может выполнять метод: любой пользователь

Метод bizproc.event.send возвращает роботу или действию выходные параметры, которые были заданы при регистрации или обновлении робота либо действия.

Вызов завершает шаг, который ждет ответа, даже если RETURN_VALUES не передан. Чтобы записать промежуточное сообщение в журнал и не завершать шаг, используйте метод bizproc.activity.log.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

EVENT_TOKEN*
string

Токен запуска робота или действия. Битрикс24 передает его на обработчик приложения в поле event_token.

Процесс примет результат, только если шаг с этим токеном еще ждет ответа. Ожидание включает параметр USE_SUBSCRIPTION: 'Y' при регистрации робота или действия. Если параметр не задали, по умолчанию шаг ответа не ждет, а включить ожидание можно в его настройках

RETURN_VALUES
object

Возвращаемые значения робота или действия. Ключи — коды параметров из RETURN_PROPERTIES, которые задали методами:

Регистр ключей не важен. Значение Битрикс24 приводит к типу Type этого параметра. Ключи, которых нет в RETURN_PROPERTIES, Битрикс24 не сохранит.

Чтобы параметр остался незаполненным, передайте пустую строку "". Если ключ не передать, параметр получит значение Default, заданное при регистрации. Подробнее — в разделе Как вернуть незаполненное значение

LOG_MESSAGE
string

Текст для журнала бизнес-процесса.

Если параметр не передать, в журнал попадет стандартная запись «Получен ответ от приложения».

Запись событий в журнал должна быть включена в шаблоне бизнес-процесса

Метод проверяет только подпись EVENT_TOKEN: с неверным токеном он вернет ошибку ACCESS_DENIED. Метод отвечает до того, как Битрикс24 передаст значения в процесс. Если шаг уже завершился, прервался по тайм-ауту или не ждет ответа, метод все равно вернет true, а процесс не изменится.

Как вернуть незаполненное значение

Чтобы робот или действие вернули параметр незаполненным, передайте в RETURN_VALUES пустую строку "". Способ работает для параметра любого типа, в том числе множественного, и при любом способе вызова метода. Пустая строка заменяет и значение Default, заданное при регистрации.

Другие значения процесс обрабатывает по-разному. Условие «не заполнено» в роботах и бизнес-процессах сработает не для всех из них.

Значение в RETURN_VALUES

Результат в процессе

""

Параметр не заполнен

Ключ не передан

Параметр получает значение Default, заданное при регистрации. Если Default не задан, параметр не заполнен

null

Параметр получает значение Default, заданное при регистрации. Если Default не задан, параметр не заполнен

false

В запросе с JSON-телом параметр не заполнен. BX24.js и CRest отправляют false как 0, и параметр получает значение 0

[]

В запросе с JSON-телом параметр не заполнен. BX24.js и CRest не отправляют пустой массив, и параметр получает значение Default

0 или "0"

Параметр заполнен значением 0

"N"

Для параметра типа bool параметр заполнен значением «Нет»

Строка из пробелов

Параметр заполнен строкой из пробелов

Примеры кода

Как использовать примеры в документации

В примере параметр outputString возвращается со значением, а errorText — незаполненным.

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"event_token":"55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90","return_values":{"outputString":"846c55d14f552180874a628d2615e285","errorText":""}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/bizproc.event.send

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"event_token":"55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90","return_values":{"outputString":"846c55d14f552180874a628d2615e285","errorText":""},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.event.send

try
{
	const response = await $b24.actions.v2.call.make({
		method: 'bizproc.event.send',
		params: {
			event_token: '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
			return_values: {
				outputString: '846c55d14f552180874a628d2615e285',
				errorText: ''
			}
		}
	});

	if (!response.isSuccess)
		console.error(response.getErrorMessages().join('; '));
	else
		console.log('Success:', response.getData().result);
}
catch (error)
{
	console.error('Error:', error);
}

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.bizproc.event.send(
        event_token="55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90",
        return_values={
            "outputString": "846c55d14f552180874a628d2615e285",
            "errorText": "",
        },
    ).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}")

try {
    $response = $b24Service
        ->core
        ->call(
            'bizproc.event.send',
            [
                'event_token' => '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
                'return_values' => [
                    'outputString' => '846c55d14f552180874a628d2615e285',
                    'errorText' => ''
                ]
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . var_export($result[0], true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error sending bizproc event: ' . $e->getMessage();
}

BX24.callMethod(
    'bizproc.event.send',
    {
        event_token: '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
        return_values: {
            outputString: '846c55d14f552180874a628d2615e285',
            errorText: ''
        }
    },
    function(result) {
        if(result.error())
            alert("Error: " + result.error());
        else
            alert("Success: " + result.data());
    }
);

require_once('crest.php');

$result = CRest::call(
    'bizproc.event.send',
    [
        'event_token' => '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
        'return_values' => [
            'outputString' => '846c55d14f552180874a628d2615e285',
            'errorText' => ''
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "bizproc.event.send", b24.Params{
	"EVENT_TOKEN": "55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90",
	"RETURN_VALUES": b24.Params{
		"outputString": "846c55d14f552180874a628d2615e285",
		"errorText":    "",
	},
})
if err != nil {
	return fmt.Errorf("bizproc.event.send: %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": 1738152544.203554,
        "finish": 1738152544.248411,
        "duration": 0.044857025146484375,
        "processing": 0.0039920806884765625,
        "date_start": "2025-01-29T15:09:04+03:00",
        "date_finish": "2025-01-29T15:09:04+03:00",
        "operating_reset_at": 1738153144,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
boolean

true, если Битрикс24 принял запрос. Это не подтверждает, что процесс применил значения

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 403

{
    "error": "ACCESS_DENIED",
    "error_description": "Access denied!"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус

Код

Описание

Значение

403

ACCESS_DENIED

Access denied!

EVENT_TOKEN не передан или его подпись неверна

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Удалить робота
Следующая
Обзор раздела