Execute the Trigger crm.automation.trigger.execute
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: administrator
The method crm.automation.trigger.execute notifies CRM automation that an application trigger has fired for an object. If this trigger is linked to a stage or status in the automation settings, it can move the object to that stage or status. For example, a telephony application executes the call_done trigger after a call, and the deal moves to the "In Progress" stage.
The method works only in the context of an application. The trigger must first be registered using the crm.automation.trigger.add method and linked to a stage in the automation settings — the workflow is described in the triggers overview.
A true response does not confirm the stage change. The method returns true even if the stage has not changed:
- the trigger is not linked to a stage, or its conditions are not met
- the object is already at the stage the trigger is linked to
- the trigger's stage comes earlier in the pipeline than the object's current stage, and moving to a previous stage is not allowed in the trigger settings
- there is no object with this
OWNER_ID
To check the result, retrieve the object's stage using the crm.item.get method.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
CODE* |
Trigger code that the application passed during registration, for example |
|
OWNER_TYPE_ID* |
Type of the CRM object according to the crm.enum.ownertype reference, for example Triggers are available for leads, deals, estimates, invoices, and SPAs. If you pass a contact or a company, the trigger fires for the objects linked to them, such as deals |
|
OWNER_ID* |
Identifier of the CRM object, such as a deal. It is returned by the crm.item.list method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"CODE":"call_done","OWNER_TYPE_ID":2,"OWNER_ID":6,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.automation.trigger.execute
// 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.execute',
params: {
CODE: 'call_done',
OWNER_TYPE_ID: 2,
OWNER_ID: 6,
},
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 event sent:', 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 executeAutomationTrigger() {
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.execute',
params: {
CODE: 'call_done',
OWNER_TYPE_ID: 2,
OWNER_ID: 6,
},
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 event sent:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', executeAutomationTrigger)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.automation.trigger.execute(
code="call_done",
owner_type_id=2,
owner_id=6,
).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 {
$result = $b24Service
->core
->call(
'crm.automation.trigger.execute',
[
'CODE' => 'call_done',
'OWNER_TYPE_ID' => 2,
'OWNER_ID' => 6,
]
)
->getResponseData()
->getResult();
// The SDK wraps the boolean result of the method in an array.
// true does not confirm the stage change: read the item to check it
echo $result[0] ? 'Trigger event sent' : 'Trigger event not sent';
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error executing automation trigger: ' . $e->getMessage();
}
BX24.callMethod(
'crm.automation.trigger.execute',
{
CODE: 'call_done',
OWNER_TYPE_ID: 2,
OWNER_ID: 6
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'crm.automation.trigger.execute',
[
'CODE' => 'call_done',
'OWNER_TYPE_ID' => 2,
'OWNER_ID' => 6
]
);
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.execute", b24.Params{
"CODE": "call_done",
"OWNER_TYPE_ID": 2,
"OWNER_ID": 6,
})
if err != nil {
return fmt.Errorf("crm.automation.trigger.execute: %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": 1790706808,
"finish": 1790706808.400356,
"duration": 0.4003560543060303,
"processing": 0,
"date_start": "2026-09-29T18:33:28+00:00",
"date_finish": "2026-09-29T18:33:28+00:00"
}
}
Returned Data
|
Name |
Description |
|
result |
|
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Incorrect parameter OWNER_TYPE_ID."
}
|
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
|
Status |
Code |
Description |
Value |
|
|
Empty value |
Access denied. |
The user does not have access to CRM |
|
|
|
Access denied! Admin permissions required |
The method was called by a user who is not an administrator |
|
|
|
Access denied! Application context required |
The method was called outside an application, for example via a webhook |
|
|
Empty value |
Empty trigger code! |
The |
|
|
Empty value |
Wrong trigger code! |
|
|
|
Empty value |
Trigger with code call_done is not registered. |
The current application has no trigger with the code from |
|
|
Empty value |
Incorrect parameter OWNER_TYPE_ID. |
CRM has no object type with this |
|
|
Empty value |
Incorrect parameter OWNER_ID. |
|
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 |