Активировать триггер crm.automation.trigger
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной 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* |
Целевой объект для автоматизации, указывается в виде |
|
code |
Уникальный символьный код триггера, настроенного в Автоматизации на конкретный статус/стадию документа. Взять параметр |
Примечание
В редких случаях для указанного в target объекта может быть обнаружено несколько триггеров. Так происходит, если:
- не передать в запрос
codeи на портале есть старые триггеры, которым не выданcode - передать
code, который окажется одинаковым для нескольких триггеров
В таком случае сработает первый триггер, который устанавливает более ранний статус объекта CRM
Также стоит учитывать, что у триггеров есть «Условия» и опция «Разрешить переходить на предыдущий статус», которые влияют на то, отработает триггер или нет.
Примеры кода
Как использовать примеры в документации
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
// 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',
params: {
target: 'DEAL_57',
code: 'c5u4m',
},
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 activated:', 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 triggerAutomation() {
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',
params: {
target: 'DEAL_57',
code: 'c5u4m',
},
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 activated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', triggerAutomation)
</script>
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();
}
Пример
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.automation.trigger(
target="DEAL_57",
code="c5u4m",
).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}")
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 |
Результат активации триггера |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":"",
"error_description":"Target is not set."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Cообщение об ошибке |
Описание |
|
Пустая строка |
Target is not set. |
Не передали обязательный параметр |
|
Пустая строка |
Incorrect target format. |
Параметр |
|
Пустая строка |
Target is not found. |
В параметр |
|
|
Access denied! There is no permissions to update the entity. |
Пользователь, не прошёл проверку прав запуска триггера. |
|
Пустая строка |
Access denied. |
Пользователь не прошёл предварительную проверку прав на доступ к CRM |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |