Добавить триггер crm.automation.trigger.add

Scope: crm

Кто может выполнять метод: администратор с доступом к CRM в контексте приложения

Метод добавляет триггер.

Запускать метод можно только в контексте приложения, так как добавленные триггеры привязываются к этому приложению.

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

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

Название
тип

Описание

CODE*
string

Внутренний уникальный (в рамках приложения) идентификатор триггера. Должен соответствовать маске [a-z0-9\.\-_].

Если передать уже существующий идентификатор триггера CODE, то произойдет обновление названия триггера NAME

NAME*
string

Название триггера

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

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

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

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.automation.trigger.add',
                    [
                        'CODE' => 'c5u4m',
                        'NAME' => 'trigger name',
                    ]
                );
        
            $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 adding automation trigger: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.automation.trigger.add',
            {
                "CODE": 'c5u4m',
                "NAME": 'trigger name'
            },
            function(result) 
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.automation.trigger.add',
            [
                'CODE' => 'c5u4m',
                'NAME' => 'trigger name'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": true,
            "time": {
                "start":1718884406.366687,
                "finish":1718884406.80718,
                "duration":0.4404928684234619,
                "processing":0.03356289863586426,
                "date_start":"2024-06-20T11:53:26+00:00",
                "date_finish":"2024-06-20T11:53:26+00:00"
            }
        }

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

Название `тип`	Описание
result `boolean`	Возвращает `true` в случае успешного добавления триггера
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error":"ACCESS_DENIED",
            "error_description":"Access denied! Application context required"
        }

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

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

Код	Cообщение об ошибке	Описание
Пустая строка	Access denied.	Пользователь не прошёл предварительную проверку прав на доступ к CRM
ACCESS_DENIED	Access denied! Admin permissions required	Не пройдена проверка прав на администратора
ACCESS_DENIED	Access denied! Application context required	Метод вызван вне контекста приложения
Пустая строка	Empty trigger code!	Пустой параметр `CODE`
Пустая строка	Wrong trigger code!	Параметр `CODE` не удовлетворяет маске `[a-z0-9\.\-_]`
Пустая строка	Empty trigger name!	Пустой параметр `NAME`

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

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.add

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

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

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

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

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

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

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

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