Активировать триггер crm.automation.trigger

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

Кто может выполнять метод: пользователь с доступом на изменение целевого объекта target

Битрикс24 позволяет пользователям создать особый пользовательский триггер "Отследить входящий вебхук". Пользователю предлагается готовый URL вида

https://mydomain.bitrix24.com/rest/1/{{PASSWORD}}/crm.automation.trigger/?target=DEAL_{{ID}}&code=nwly5

обращение к котрому из внешнего источника приведёт к срабатыванию триггера и соответствующему переходу элемента CRM на другую стадию воронки.

Как вы можете видеть по формату этого URL, фактически, внутри Битрикс24 создаётся локальный входящий вебхук, с помощью которого происходит обращение к методу crm.automation.trigger с указанием конкретного объекта CRM и того уникального символьного кода триггера, который был создан самим Битрикс24 (в примере выше это nwly5).

Вы можете использовать метод не только с помощью входящего вебука, но и в контексте локальных и тиражных приложений. Однако для вызова собственных триггеров, которые создаются вашим же приложением, нужно использовать метод crm.automation.trigger.execute

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

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

Название `тип`	Описание
target* `string`	Целевой объект для автоматизации, указывается в виде `TYPENAME_ID` (например, `LEAD_25`)
code `string`	Уникальный символьный код триггера, настроенного в Автоматизации на конкретный статус/стадию документа. Взять параметр `code` можно из настроек триггера

Примечание

В редких случаях для указанного в target объекта может быть обнаружено несколько триггеров. Так происходит, если:

не передать в запрос code и на портале есть старые триггеры, которым не выдан code
передать code, который окажется одинаковым для нескольких триггеров
В таком случае сработает первый триггер, который устанавливает более ранний статус объекта CRM

Также стоит учитывать, что у триггеров есть «Условия» и опция «Разрешить переходить на предыдущий статус», которые влияют на то, отработает триггер или нет.

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"target":"DEAL_57","code":"c5u4m"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automation.trigger

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"target":"DEAL_57","code":"c5u4m","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automation.trigger

try
        {
        	const response = await $b24.callMethod(
        		"crm.automation.trigger",
        		{
        			target: 'DEAL_57',
        			code: 'c5u4m',
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.automation.trigger',
                    [
                        'target' => 'DEAL_57',
                        'code'   => 'c5u4m',
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error triggering automation: ' . $e->getMessage();
        }

BX24.callMethod(
            "crm.automation.trigger",
            {
                target: 'DEAL_57',
                code: 'c5u4m',
            },
            function(result) 
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automation.trigger',
            [
                'target' => 'DEAL_57',
                'code' => 'c5u4m'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start":1718809827.810153,
                "finish":1718809828.541046,
                "duration":0.7308928966522217,
                "processing":0.09834408760070801,
                "date_start":"2024-06-19T15:10:27+00:00",
                "date_finish":"2024-06-19T15:10:28+00:00"
            }
        }

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

Название `тип`	Описание
result `boolean`	Результат активации триггера
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error":"",
            "error_description":"Target is not set."
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Cообщение об ошибке	Описание
Пустая строка	Target is not set.	Не передали обязательный параметр `target`
Пустая строка	Incorrect target format.	Параметр `target` передан не в том формате, который нужен (Необходимый формат `TYPENAME_ID`)
Пустая строка	Target is not found.	В параметр `target` передали неправильный `TYPENAME`
`ACCESS_DENIED`	Access denied! There is no permissions to update the entity.	Пользователь, не прошёл проверку прав запуска триггера.
Пустая строка	Access denied.	Пользователь не прошёл предварительную проверку прав на доступ к CRM

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Об автоматизации

Обзор методов

Активировать триггер crm.automation.trigger

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

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

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

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

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

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

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