Sign in
Workflows

Execute a workflow

Executes a workflow with the specified login and parameters

post/workflows/execute

Request body

workflowIdstring

ID of the workflow to execute. Either workflowId or workflowName must be provided.

workflowNamestring

Name of the workflow to execute. If provided, the workflow will be looked up by name within the organization. Either workflowId or workflowName must be provided.

loginIdstring

ID of the login to use for authentication

paramsobject required

Runtime parameters for the workflow execution

timeoutinteger

Optional timeout in seconds for the execution (defaults to 10800 seconds / 3 hours)

useProxyboolean

Whether to use a proxy for this execution

startBlockIdstring

Optional ID of the block to start execution from

batchIdstring

Optional ID of the execution batch to assign this execution to

isTestboolean

Whether this execution is a test run

agentConversationThreadIdstring

Optional ID of an agent conversation thread to associate with this execution (used when duplicating executions that were triggered by an agent)

Example request

{
  "params": {
    "origin": "New York",
    "destination": "Los Angeles"
  },
  "timeout": 10800,
  "startBlockId": "1",
  "batchId": "batch_123"
}

Response

Workflow execution started successfully

executionIdstring required

ID of the created execution

statusstring required

Status of the execution

messagestring required

Message about the execution

Example response

{
  "executionId": "1",
  "status": "Processing",
  "message": "Workflow execution started successfully"
}

Changes