Execute the Trigger crm.automation.trigger.execute

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

Scope: crm

Who can execute the method: administrator with access to CRM in the application context

This method initiates the execution of a trigger.

The method can only be called in the application context.

Method Parameters

Required parameters are marked with *

Name `type`	Description
CODE* `string`	Internal unique (within the application) identifier of the trigger. Must match the pattern `[a-z0-9\.\-_]`
OWNER_TYPE_ID* `integer`	Type of the CRM object according to the crm.enum.ownertype reference (For example, `1` — lead) Triggers exist in leads, deals, estimates, invoices, and SPAs
OWNER_ID* `integer`	Identifier of the entity

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

Python

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"c5u4m","OWNER_TYPE_ID":2,"OWNER_ID":6}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automation.trigger.execute

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"c5u4m","OWNER_TYPE_ID":2,"OWNER_ID":6,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automation.trigger.execute

try
        {
        	const response = await $b24.callMethod(
        		'crm.automation.trigger.execute',
        		{
        			CODE: 'c5u4m',
        			OWNER_TYPE_ID: 2,
        			OWNER_ID: 6
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        	{
        		console.error(result.error());
        	}
        	else
        	{
        		console.dir(result);
        	}
        }
        catch(error)
        {
        	console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.automation.trigger.execute',
                    [
                        'CODE'         => 'c5u4m',
                        'OWNER_TYPE_ID' => 2,
                        'OWNER_ID'     => 6,
                    ]
                );
        
            $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 executing automation trigger: ' . $e->getMessage();
        }

Example

from b24pysdk.client import BaseClient
        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        client: BaseClient
        
        try:
            bitrix_response = client.crm.automation.trigger.execute(
                code="c5u4m",
                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}")

BX24.callMethod(
            'crm.automation.trigger.execute',
            {
                CODE: 'c5u4m',
                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' => 'c5u4m',
                'OWNER_TYPE_ID' => 2,
                'OWNER_ID' => 6
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 200

{
            "result":true,
            "time":{
                "start":1718891973.429101,
                "finish":1718891986.721889,
                "duration":13.292788028717041,
                "processing":13.012810945510864,
                "date_start":"2024-06-20T13:59:33+00:00",
                "date_finish":"2024-06-20T13:59:46+00:00"
            }
        }

Returned Data

Name `type`	Description
result `boolean`	Returns true if the trigger was successfully initiated
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error":"",
            "error_description":"Incorrect parameter OWNER_TYPE_ID."
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Error Message	Description
Empty string	Access denied.	User did not pass the preliminary access rights check for CRM
ACCESS_DENIED	Access denied! Admin permissions required	Admin rights check failed
ACCESS_DENIED	Access denied! Application context required	Method called outside of application context
Empty string	Empty trigger code!	Empty `CODE` parameter
Empty string	Wrong trigger code!	`CODE` parameter does not match the pattern `[a-z0-9\.\-_]`
Empty string	Trigger with code {$code} is not registered.	Application trigger not found
Empty string	Incorrect parameter OWNER_TYPE_ID.	Provided `owner_type_id` is not defined in CRM
Empty string	Incorrect parameter OWNER_ID.	Provided `owner_id` parameter value is incorrect (value is not positive)

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not permitted for calls using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site 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

Continue Learning

Add Trigger

Get List of Triggers

Execute the Trigger crm.automation.trigger.execute

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning