bizproc.event.send — метод REST API Битрикс24

Описание

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

Параметры

EVENT_TOKEN string обязательный

Специальный токен, который приходит на обработчик приложения, когда выполняется действие или робот. Значение этого токена обработчик получает в массиве входных данных.

Отправить событие можно, если робот или действие зарегистрированы с 'USE_SUBSCRIPTION': 'Y'

RETURN_VALUES object необязательный

Массив возвращаемых значений действия или робота. Указываются значения свойств, которые были зарегистрированы как дополнительные результаты RETURN_PROPERTIES методами:
- bizproc.robot.add, bizproc.robot.update
- bizproc.activity.add, bizproc.activity.update

LOG_MESSAGE string необязательный

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

Если параметр не передать, метод отправит пустую строку.

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

Примеры запроса

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"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/bizproc.event.send

try
{
	const response = await $b24.callMethod(
		'bizproc.event.send',
		{
			event_token: '55c1dc1c3f0d75.78875596|A51601_82584_96831_81132|hsyUws1j4XiwqPqN45eH66CcQtEvpUIP.47dd5d888e8e549d2c984713e12a4268e6e87d0208ca1f093ba1075e77f92e90',
			return_values: {
				outputString: '846c55d14f552180874a628d2615e285'
			}
		}
	);
	
	if(response.error())
		alert("Error: " + response.error());
	else
		alert("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",
        },
    ).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'
                ]
            ]
        );

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

    if ($result->error()) {
        echo 'Error: ' . $result->error();
    } else {
        echo 'Success: ' . $result->data();
    }

} 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'
        }
    },
    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'
        ]
    ]
);

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",
	},
})
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, если значения успешно переданы в процесс

time time

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

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

HTTP-статус: 403

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

Код	Описание	Значение
`ACCESS_DENIED`	Access denied!	Невалидный или устаревший `EVENT_TOKEN`