Добавить триггер crm.automation.trigger.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
crmКто может выполнять метод: администратор
Метод crm.automation.trigger.add регистрирует триггер приложения — событие, по которому CRM может перевести сделку или другой объект на нужную стадию или в статус. Например, приложение телефонии регистрирует триггер «Звонок завершен» с кодом call_done. Затем администратор привязывает его к стадии в настройках автоматизации CRM, и приложение запускает триггер методом crm.automation.trigger.execute. Порядок работы описан в обзоре триггеров.
Работает только в контексте приложения: триггер принадлежит приложению, которое его зарегистрировало.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
CODE* |
Код триггера, уникальный в рамках приложения, например Если у приложения уже есть триггер с таким |
|
NAME* |
Название триггера. Его видно в настройках автоматизации CRM, когда триггер привязывают к стадии |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"call_done","NAME":"Звонок завершен","auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.automation.trigger.add
// 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: 'crm.automation.trigger.add',
params: {
CODE: 'call_done',
NAME: 'Звонок завершен',
},
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('Trigger added:', 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 addAutomationTrigger() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.automation.trigger.add',
params: {
CODE: 'call_done',
NAME: 'Звонок завершен',
},
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('Trigger added:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addAutomationTrigger)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.automation.trigger.add(
code="call_done",
name="Звонок завершен",
).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 {
$result = $b24Service
->core
->call(
'crm.automation.trigger.add',
[
'CODE' => 'call_done',
'NAME' => 'Звонок завершен',
]
)
->getResponseData()
->getResult();
// The SDK wraps the boolean result of the method in an array
echo $result[0] ? 'Trigger saved' : 'Trigger not saved';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding automation trigger: ' . $e->getMessage();
}
BX24.callMethod(
'crm.automation.trigger.add',
{
"CODE": 'call_done',
"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' => 'call_done',
'NAME' => 'Звонок завершен'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.automation.trigger.add", b24.Params{
"CODE": "call_done",
"NAME": "Звонок завершен",
})
if err != nil {
return fmt.Errorf("crm.automation.trigger.add: %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":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 |
|
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 403
{
"error": "ACCESS_DENIED",
"error_description": "Access denied! Application context required"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
Пустое значение |
Access denied. |
У пользователя нет доступа к CRM |
|
|
|
Access denied! Admin permissions required |
Метод вызвал не администратор |
|
|
|
Access denied! Application context required |
Метод вызван не из приложения, например через вебхук |
|
|
Пустое значение |
Empty trigger code! |
Параметр |
|
|
Пустое значение |
Wrong trigger code! |
В |
|
|
Пустое значение |
Empty trigger name! |
Параметр |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |