Add Trigger crm.automation.trigger.add

Scope: crm

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

This method adds a trigger.

The method can only be executed in the application context, as the added triggers are tied to this application.

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\.\-_].

If an existing trigger identifier CODE is provided, the trigger name NAME will be updated.

NAME*
string

Name of the trigger

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"c5u4m","NAME":"trigger name"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.automation.trigger.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"CODE":"c5u4m","NAME":"trigger name","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.automation.trigger.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.automation.trigger.add',
        		{
        			"CODE": 'c5u4m',
        			"NAME": 'trigger name'
        		}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.automation.trigger.add',
                    [
                        'CODE' => 'c5u4m',
                        'NAME' => 'trigger name',
                    ]
                );
        
            $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 adding automation trigger: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.automation.trigger.add',
            {
                "CODE": 'c5u4m',
                "NAME": 'trigger 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' => 'c5u4m',
                'NAME' => 'trigger name'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP status: 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"
            }
        }

Returned Data

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

Error Handling

HTTP status: 400

{
            "error":"ACCESS_DENIED",
            "error_description":"Access denied! Application context required"
        }

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 parameter `CODE`
Empty string	Wrong trigger code!	Parameter `CODE` does not match the pattern `[a-z0-9\.\-_]`
Empty string	Empty trigger name!	Empty parameter `NAME`

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 allowed to be called 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 methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks 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 account administrator has allowed access to this application only for specific users
`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 option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of Methods

Execute Trigger

Add Trigger crm.automation.trigger.add

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