executions

Start new automation execution

post/v1/automation/executions

Request

  • Base URL
    https://automation.sls.epilot.io
  • URL
    https://automation.sls.epilot.io/v1/automation/executions
  • Auth
    HTTP bearer

Request body

entity_idstring required
flow_idstring required

ID of the Automation Flow

flow_execution_idstring

Use workflow_context.workflow_exec_id instead

flow_automation_task_idstring

Use workflow_context.workflow_exec_task_id instead

Example request

{
  "entity_id": "e3d3ebac-baab-4395-abf4-50b5bf1f8b74",
  "flow_id": "7791b04a-16d2-44a2-9af9-2d59c25c512f",
  "workflow_context": {
    "trigger_user_id": "10006129",
    "run_by": {
      "user_id": "10006129",
      "org_id": "739224"
    }
  },
  "action_inputs": {
    "cancel-flow-execution": {
      "selected_reasons": [
        {
          "id": "_6kITMwkv_0Uo4i7fO7Ja",
          "title": "Process completed successfully"
        }
      ]
    }
  }
}

Response

The created execution

idstring required
execution_status'pending' | 'starting' | 'in_progress' | 'paused' | 'success' | 'failed' | 'cancelled' | 'skipped' | 'scheduled' | 'hot'
entity_idstring required
activity_idstring
org_idstring required
flow_idstring required

ID of the Automation Flow

flow_namestring
created_atstring date-time
updated_atstring date-time
current_action_idstring
resume_tokenstring

A unique token to resume a paused automation execution

trigger_contextTriggerContext

Additional contextual data for a bulk trigger automation. This would normally include additional entity IDs you'd need after a listener picks up an event.

versionnumber

Version of the flow

loop_stateobject

Runtime iteration state, keyed by loop_id. Tracks the current_index and total for each active loop scope. Entries are removed once a loop exits.

chainstring[]

Ordered automation flow ids in this execution's trigger chain (multi-automation loop prevention).

Changes

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status