CRM Automation Triggers: Overview of Methods

CRM automation triggers help the application transmit external events to the CRM. If a trigger is configured for an object, the event can move it to the desired stage or status.

The group of methods crm.automation.trigger.* allows you to register an application trigger, retrieve a list of registered triggers, send an event to CRM automation, and delete an unnecessary trigger.

Quick navigation: all methods

User documentation: Triggers in CRM

Getting StartedGetting Started

1. Register a trigger using the crm.automation.trigger.add method.

2. Link the registered trigger to the desired stage or status in the Bitrix24 automation settings.

3. If necessary, retrieve the list of application triggers using the crm.automation.trigger.list method.

4. Prepare the CRM object identifiers: OWNER_TYPE_ID and OWNER_ID.

5. Execute the trigger using the crm.automation.trigger.execute method.

6. Delete the unnecessary trigger using the crm.automation.trigger.delete method.

Key ParametersKey Parameters

CODE. The identifier of the trigger within the application. The application assigns it when registering the trigger using the crm.automation.trigger.add method. This identifier is then used in the crm.automation.trigger.execute and crm.automation.trigger.delete methods.

If an existing CODE is passed to the add method, it will update the NAME parameter of the trigger.

OWNER_TYPE_ID. The identifier of the CRM object type. Used in the crm.automation.trigger.execute method. The object type must support CRM automation.

OWNER_ID. The identifier of a specific CRM object. Used in the crm.automation.trigger.execute method.

Important ConsiderationsImportant Considerations

• The crm.automation.trigger.execute method sends an event to CRM automation but does not confirm the change of stage or status.

• The change of stage or status will occur only if a trigger for the desired object is already configured with the same CODE in the current application.

Relationship with Other ObjectsRelationship with Other Objects

CRM Automation. After registering the application trigger, it can be selected using the methods in the CRM Automation section and linked to the desired stage or status.

CRM Objects. In the crm.automation.trigger.execute method, the parameters OWNER_TYPE_ID and OWNER_ID define the type of CRM object and the specific object for triggering. The value of OWNER_TYPE_ID can be obtained using the crm.enum.ownertype method. The OWNER_ID identifier can be obtained using the universal crm.item.list method.

Overview of MethodsOverview of Methods

Scope: crm

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

Method	Description
crm.automation.trigger.add	Adds an application trigger
crm.automation.trigger.list	Retrieves a list of application triggers
crm.automation.trigger.execute	Executes the trigger for a CRM object
crm.automation.trigger.delete	Deletes a trigger