Create workflow

curl --request POST \ --url https://api.cloudcruise.com/workflows \ --header 'Content-Type: application/json' \ --header 'cc-key: <api-key>' \ --data ' { "name": "<string>", "nodes": [ { "id": "<string>", "name": "<string>", "action": "START", "parameters": {}, "description": "<string>" } ], "edges": {}, "input_schema": {}, "output_schema": {}, "max_retries": 123, "description": "<string>", "version_note": "<string>", "use_native_actions": true, "video_record_session": true, "extract_network_urls": [ "<string>" ], "encrypted_keys": [ "<string>" ], "popup_xpaths": [ "<string>" ], "vault_schema": { "USER": { "type": "credential", "domain": "https://example.com", "example": "11223344-5566-7788-9900-112233445566" } }, "enable_popup_handling": true, "enable_action_timing_recovery": true, "enable_xpath_recovery": true, "enable_node_description_enrichment": true, "enable_error_code_generation": true, "enable_service_unavailable_recovery": true, "enable_incorrect_form_input_recovery": true, "enable_password_update_recovery": true, "enable_tfa_setup_recovery": true, "proxy_setting": "<string>", "proxy_value": "<string>", "enable_network_listener": true, "skip_udp_proxying": true } '

{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "nodes": [ {} ], "edges": {}, "description": "<string>", "version_number": 123, "version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "input_schema": {}, "vault_schema": {}, "enable_popup_handling": true, "enable_xpath_recovery": true, "enable_node_description_enrichment": true, "enable_error_code_generation": true, "enable_service_unavailable_recovery": true, "enable_incorrect_form_input_recovery": true, "enable_password_update_recovery": true, "enable_tfa_setup_recovery": true, "enable_action_timing_recovery": true, "origin_catalog_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "origin_catalog_version_number": 123, "origin_catalog_workflow_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "origin_base_version_number": 123, "track_updates_from_catalog": true, "enable_network_listener": true, "skip_udp_proxying": true }

Authorizations

cc-key

string

header

required

API key-based authentication. Provide your CloudCruise API key in the cc-key header.

Headers

cc-key

string

CloudCruise API key for authentication

Body

application/json

Payload for creating a new workflow via POST. The workflow ID is generated server-side.

name

string

required

Display name of the workflow

nodes

object[]

required

Array of workflow step nodes

Show child attributes

edges

object

required

Map of edges connecting workflow nodes

Show child attributes

input_schema

object

required

JSON Schema defining the workflow's input variables

output_schema

object

required

JSON Schema defining the workflow's output variables

max_retries

integer

required

Maximum number of retry attempts for failed workflow steps

description

string | null

Optional description of the workflow

version_note

string

Optional note describing this version

use_native_actions

boolean | null

Whether to use native browser actions instead of simulated events

video_record_session

boolean | null

Whether to record a video of the workflow execution

extract_network_urls

string[] | null

URL patterns to extract from network traffic during execution

encrypted_keys

string[] | null

References to encrypted vault keys used by this workflow

XPath selectors for popups that should be automatically dismissed

vault_schema

object

Schema defining vault credentials required by this workflow

Show child attributes

Example:

{
  "USER": {
    "type": "credential",
    "domain": "https://example.com",
    "example": "11223344-5566-7788-9900-112233445566"
  }
}

Whether automatic popup handling is enabled

enable_action_timing_recovery

boolean

Whether action timing recovery is enabled

enable_xpath_recovery

boolean

Whether automatic XPath recovery is enabled

enable_node_description_enrichment

boolean

Whether node descriptions are auto-enriched for reliability improvements

enable_error_code_generation

boolean

Whether automatic error code generation is enabled

enable_service_unavailable_recovery

boolean

Whether service unavailable recovery is enabled

enable_incorrect_form_input_recovery

boolean

Whether incorrect form input recovery is enabled

enable_password_update_recovery

boolean

Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.

enable_tfa_setup_recovery

boolean

Whether automatic TFA setup recovery is enabled. When a site requires two-factor authentication setup during login, the Maintenance Agent can autonomously complete the enrollment and update the vault credential.

proxy_setting

string

Proxy configuration setting

proxy_value

string

Proxy value

enable_network_listener

boolean

Whether the network listener is enabled

skip_udp_proxying

boolean

Whether UDP proxying is skipped during workflow execution

Response

Workflow created successfully

Full workflow definition including nodes and edges

string<uuid>

required

Unique identifier for the workflow

name

string

required

Name of the workflow

created_at

string<date-time>

required

Timestamp when the workflow was created

updated_at

string<date-time>

required

Timestamp when the workflow was last updated

workspace_id

string<uuid>

required

ID of the workspace this workflow belongs to

created_by

string<uuid>

required

ID of the user who created the workflow

nodes

object[]

required

Array of workflow step nodes

edges

object

required

Map of edges connecting workflow nodes

Show child attributes

description

string | null

Description of the workflow

version_number

integer

Current version number of the workflow

version_id

string<uuid>

ID of the current workflow version

input_schema

object

JSON schema defining the workflow's input variables

vault_schema

object

Schema defining vault credentials and their configuration

Whether popup handling is enabled for this workflow

enable_xpath_recovery

boolean

Whether XPath recovery is enabled for this workflow

enable_node_description_enrichment

boolean

Whether node descriptions are auto-enriched for reliability improvements

enable_error_code_generation

boolean

Whether error code generation is enabled for this workflow

enable_service_unavailable_recovery

boolean

Whether service unavailable recovery is enabled for this workflow

enable_incorrect_form_input_recovery

boolean

Whether incorrect form input recovery is enabled

enable_password_update_recovery

boolean

Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.

enable_tfa_setup_recovery

boolean

enable_action_timing_recovery

boolean

Whether action timing recovery is enabled for this workflow

origin_catalog_workflow_id

string<uuid> | null

ID of the catalog workflow this was forked from (if applicable)

origin_catalog_version_number

integer | null

Version number of the catalog workflow this was forked from

origin_catalog_workflow_version_id

string<uuid> | null

Specific origin catalog workflow version ID used as the base

origin_base_version_number

integer | null

Base version number used when deriving from a catalog workflow

track_updates_from_catalog

boolean

Whether to track updates from the origin catalog workflow

enable_network_listener

boolean

Whether network listener capture is enabled for this workflow version

skip_udp_proxying

boolean

Whether UDP proxying is skipped for this workflow version

Getting Started

Concepts

API Reference

SDK

Integrations

Authorizations

Headers

Body

Response

Getting Started

Concepts

API Reference

SDK

Integrations

Documentation Index

Authorizations

Headers

Body

Response