bx24_workflows
Manage and automate Bitrix24 business processes and robots: create templates, start or terminate workflows, handle approval tasks, and control robots and activities.
Instructions
Bitrix24 business processes & robots: templates, instances, tasks, robots, activities. Methods bizproc.workflow., bizproc.workflow.template., bizproc.task., bizproc.robot., bizproc.activity.* (REST 1.0 + 3.0). RU/EN: бизнес-процесс, робот, запустить процесс, шаблон, задача БП,杀ить / workflow, business process, robot, start, template, kill.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Entity ID | |
| order | No | Order object (e.g. { 'ID': 'DESC' }) | |
| start | No | Pagination offset (number of records to skip) | |
| action | Yes | Operation to perform: - "template_list": List workflow templates - "template_get": Get a template by ID - "template_add": Add a workflow template - "template_update": Update a workflow template - "template_delete": Delete a workflow template (destructive) - "start": Start a workflow for a document (templateId, documentId) - "kill": Kill a running workflow (destructive) - "workflow_terminate": Terminate a workflow execution (graceful stop, destructive) - "task_list": List workflow tasks (approvals) - "task_complete": Complete a workflow task - "task_get": Get a workflow task by ID - "task_delegate": Delegate a workflow task to a user - "robot_list": List robots - "robot_add": Register an app robot - "robot_update": Update an app robot - "robot_delete": Delete an app robot (destructive) - "activity_list": List activities - "activity_get": Get an activity - "activity_add": Add an app activity - "activity_update": Update an app activity - "activity_delete": Delete an app activity (destructive) - "activity_log": Write a message to the workflow log - "event_send": Send robot/activity outputs to the workflow (bizproc.event.send) - "instance_list": List running workflow instances - "instance_terminate": Terminate a workflow instance (destructive) | |
| filter | No | Filter object (e.g. { '>OPPORTUNITY': 10000, 'STAGE_ID': 'WON' }) | |
| select | No | Array of field names to return (projection) | |
| taskId | No | BP task ID | |
| confirm | No | Set to true to confirm destructive actions when BX24_CONFIRM_DESTRUCTIVE is enabled. | |
| logFields | No | Log message fields | |
| documentId | No | Document ID tuple, e.g. ['crm','DEAL',456] | |
| parameters | No | Workflow parameters | |
| taskFields | No | Task fields (answer) | |
| templateId | No | Template ID | |
| eventFields | No | Event fields for bizproc.event.send | |
| robotFields | No | Robot fields: CODE, NAME, ... | |
| activityFields | No | Activity fields: CODE, NAME, ... |