CRM Automation: Overview of Methods

The methods in this section allow external events to be transmitted to CRM automation through triggers. When a trigger is configured for an object, it transitions the object to another stage or status.

This section includes two scenarios. In the first, a pre-configured webhook trigger is initiated using the crm.automation.trigger method — the trigger is set up in the Bitrix24 interface and then called via the API. In the second scenario, the application registers the trigger and manages it through the methods in the CRM Automation Triggers section.

Quick navigation: all methods

User documentation:

• Triggers in CRM
• Sales Automation in CRM

Getting StartedGetting Started

If the webhook trigger is already configured in Bitrix24:

1. Retrieve the code value from the URL of the "Track Incoming Webhook" trigger in the CRM automation settings.
2. Construct the target for the target object, for example, DEAL_25.
3. Call crm.automation.trigger, passing the target and code.
4. If necessary, check the result using the crm.item.get method.

If you need to manage triggers from the application:

The complete procedure is outlined in the CRM Automation Triggers section: registration, binding to a stage, and execution.

Interaction with Other ObjectsInteraction with Other Objects

CRM Automation. In both scenarios, the trigger must be pre-bound to a stage or status in the Bitrix24 automation settings.

CRM Objects. The trigger is initiated for a specific CRM object. In the webhook scenario, the target parameter passes the string identifier of the object in the format TYPENAME_ID, for example, DEAL_25, where DEAL is the CRM object type and 25 is its numeric identifier from crm.item.list. In the application scenario, the object type OWNER_TYPE_ID is obtained using the crm.enum.ownertype method, and the object identifier OWNER_ID is retrieved using the crm.item.list method.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the method: depends on the method

Launching a Configured TriggerLaunching a Configured Trigger

Method	Description
crm.automation.trigger	Launches the webhook trigger configured in CRM automation

Application TriggersApplication Triggers

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