Application Actions: Overview of Methods

Application actions add a step to the workflow designer that triggers an application handler. This step accepts input parameters, can wait for a response from the application, and returns output values to the process.

In the REST API, application actions and Automation rules are similar in model. Registration, updating, deletion, and listing are available as separate methods for each type. Within the platform, processing is built on a common mechanism. The record type is determined by the internal system attribute IS_ROBOT, which distinguishes records as actions or robots. A value of Y indicates a robot, while N indicates an action. In the methods bizproc.activity.*, this attribute is not passed.

Application actions are primarily suitable for supporting existing integrations and enhancing previously added actions. For new development, it is recommended to use Automation rules. They operate in CRM automation and workflows, covering more scenarios.

Quick navigation: all methods

Scenarios Suitable for Application ActionsScenarios Suitable for Application Actions

• Add a step to the workflow template that calls an external application service.
• Pass parameters from the workflow document to the action and return output data to the process.
• Log intermediate messages in the workflow.
• Restrict the availability of the action based on document type and Bitrix24 edition.
• Fine-tune the logic within an already functioning template without migrating to another type of automation.
• Implement auxiliary scenarios for monitoring and executing workflow tasks.

Getting StartedGetting Started

1. Register the action via bizproc.activity.add.
2. If you need to return a result, specify RETURN_PROPERTIES with a description of the output parameters and set USE_SUBSCRIPTION to 'Y' when registering or updating the action through bizproc.activity.add and bizproc.activity.update. Then pass the values through bizproc.event.send.
3. If necessary, restrict the availability of the action using FILTER in bizproc.activity.add and bizproc.activity.update. Use INCLUDE and EXCLUDE rules, for example for cloud b24 or on-premise box.
4. Add the action to the template and start the process:
   • through the interface in the workflow designer
   • through template methods bizproc.workflow.template.add, bizproc.workflow.template.update, and bizproc.workflow.start.
5. For diagnostics and execution control, log stages in the log via bizproc.activity.log.
6. Check the installed actions through bizproc.activity.list.
7. Remove outdated actions via bizproc.activity.delete.

Important ConsiderationsImportant Considerations

• The methods bizproc.activity.add, bizproc.activity.update, bizproc.activity.list, bizproc.activity.delete only work in the context of the installed application.
• For bizproc.activity.log and bizproc.event.send, a unique key EVENT_TOKEN is required, which is sent to the HANDLER during the execution of the action in the workflow.

Relationships with Other ObjectsRelationships with Other Objects

• Workflow Templates. The action becomes available in the designer after registration via bizproc.activity.add and is used within the template when it is launched.
• Document Type. Through DOCUMENT_TYPE and FILTER, the action is linked to the appropriate document type and is displayed only in the relevant context.
• Automation Rules. Actions and robots use a common internal mechanism, so it is important to consider overlaps in codes and scenarios during registration.

Overview of MethodsOverview of Methods

Scope: bizproc

Who can execute the method: depends on the method

Method	Description
bizproc.activity.add	Adds a new action for use in workflows
bizproc.activity.update	Updates an action
bizproc.activity.list	Retrieves a list of actions installed by the application
bizproc.activity.delete	Deletes an action installed by the application
bizproc.activity.log	Logs information in the workflow log