Activate the crm.automation.trigger
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: a user with access permission to modify the target object
target
Bitrix24 allows users to create a special custom trigger "Track Inbound Webhook." The user is provided with a ready-made URL of the form
https://mydomain.bitrix24.com/rest/1/{{PASSWORD}}/crm.automation.trigger/?target=DEAL_{{ID}}&code=nwly5
A call to this URL from an external source will trigger the automation and transition the CRM object to another stage in the Sales Funnel.
As you can see from the format of this URL, a local inbound webhook is effectively created within Bitrix24, which calls the crm.automation.trigger method, specifying a specific CRM object and the unique symbolic code of the trigger that was created by Bitrix24 itself (in the example above, this is nwly5).
You can use the method not only via the inbound webhook but also in the context of local and mass-market applications. However, to invoke your own triggers created by your application, you need to use the method crm.automation.trigger.execute
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
target* |
Target object for automation, specified in the form of |
|
code |
Unique symbolic code of the trigger configured in Automation for a specific status/stage of the document. The |
Note
In rare cases, multiple triggers may be detected for the specified target object. This happens if:
codeis not passed in the request and there are old triggers on the account that do not have acode- a
codeis passed that turns out to be the same for multiple triggers
In this case, the first trigger that sets an earlier status for the CRM object will be activated.
It is also worth noting that triggers have "Conditions" and the option "Allow transitioning to the previous status," which affect whether the trigger will work or not.
Code Examples
How to Use Examples in Documentation
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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected 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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.automation.trigger", b24.Params{
"target": "DEAL_57",
"code": "c5u4m",
})
if err != nil {
return fmt.Errorf("crm.automation.trigger: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP Status: 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"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of trigger activation |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":"",
"error_description":"Target is not set."
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Error Message |
Description |
|
Empty string |
Target is not set. |
The required parameter |
|
Empty string |
Incorrect target format. |
The |
|
Empty string |
Target is not found. |
An incorrect |
|
|
Access denied! There are no permissions to update the entity. |
The user did not pass the permission check to trigger the automation. |
|
Empty string |
Access denied. |
The user did not pass the preliminary permission check for CRM access |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |