POST
/
workflows
/
get
Get workflow
curl --request POST \
  --url https://api.kaizenautomation.com/workflows/get \
  --header 'Content-Type: application/json' \
  --data '{
  "workflowId": "<string>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "isAuthenticationRequired": true,
  "autoSaveEnabled": true,
  "timeoutMs": 1800000,
  "shouldPauseOnError": false,
  "shouldSelfHeal": true,
  "shouldSaveResultFile": false,
  "maxConcurrentSessions": 10,
  "webhookUrls": [
    "<string>"
  ],
  "blocks": [
    {
      "id": "<string>",
      "name": "<string>",
      "blockReferenceId": "<string>",
      "transformerFn": "<string>",
      "type": "<string>",
      "locator": {
        "role": "<string>",
        "text": "<string>",
        "label": "<string>",
        "placeholder": "<string>",
        "altText": "<string>",
        "title": "<string>",
        "css": "<string>",
        "xpath": "<string>"
      },
      "isCacheable": true,
      "skipIfNotPresent": true,
      "data": {
        "loginId": "<string>",
        "isParameter": true
      },
      "parentRelationship": {
        "blockDepth": 123,
        "positionInSequence": 123,
        "parentBlockId": "<string>",
        "parentSequenceId": "sequence"
      }
    }
  ],
  "useProxy": false,
  "knowledgeBase": "Company information and guidelines..."
}

Body

application/json
workflowId
string
required

ID of the workflow to retrieve

Response

Workflow retrieved successfully

id
string
required

ID of the workflow

name
string
required

Name of the workflow

isAuthenticationRequired
boolean
required

Whether authentication is required for this workflow

autoSaveEnabled
boolean
required

Whether auto-save is enabled for this workflow

blocks
array
required

Blocks of the workflow

timeoutMs
integer | null

Timeout in milliseconds for workflow execution

Example:

1800000

shouldPauseOnError
boolean

Whether to pause workflow execution on error

Example:

false

shouldSelfHeal
boolean

Whether to automatically clean up cache when workflow execution fails

Example:

true

shouldSaveResultFile
boolean

Whether to save result files for this workflow

Example:

false

maxConcurrentSessions
integer | null

Maximum concurrent executions for this workflow

Required range: x > 0
Example:

10

webhookUrls
string<uri>[]

List of webhook URLs for this workflow

useProxy
boolean

Whether to use proxy for this workflow

Example:

false

knowledgeBase
string

Knowledge base text for this workflow

Example:

"Company information and guidelines..."