Create workflow
Creates a new workflow in the workspace associated with your API key.
The workflow ID is generated server-side. The response includes the full workflow definition with the assigned ID, which you can use for subsequent operations (e.g., starting runs, updating the workflow).
Versioning: The initial creation produces version 1. Use PUT /workflows/{workflow_id} to create subsequent versions.
Authorizations
API key-based authentication. Provide your CloudCruise API key in the cc-key header.
Headers
CloudCruise API key for authentication
Body
Payload for creating a new workflow via POST. The workflow ID is generated server-side.
Display name of the workflow
Array of workflow step nodes
Map of edges connecting workflow nodes
JSON Schema defining the workflow's input variables
JSON Schema defining the workflow's output variables
Maximum number of retry attempts for failed workflow steps
Optional description of the workflow
Optional note describing this version
Whether to use native browser actions instead of simulated events
Whether to record a video of the workflow execution
URL patterns to extract from network traffic during execution
References to encrypted vault keys used by this workflow
XPath selectors for popups that should be automatically dismissed
Schema defining vault credentials required by this workflow
{
"USER": {
"type": "credential",
"domain": "https://example.com",
"example": "11223344-5566-7788-9900-112233445566"
}
}Whether automatic popup handling is enabled
Whether action timing recovery is enabled
Whether automatic XPath recovery is enabled
Whether node descriptions are auto-enriched for reliability improvements
Whether automatic error code generation is enabled
Whether service unavailable recovery is enabled
Whether incorrect form input recovery is enabled
Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.
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 configuration setting
Proxy value
Whether the network listener is enabled
Whether UDP proxying is skipped during workflow execution
Response
Workflow created successfully
Full workflow definition including nodes and edges
Unique identifier for the workflow
Name of the workflow
Timestamp when the workflow was created
Timestamp when the workflow was last updated
ID of the workspace this workflow belongs to
ID of the user who created the workflow
Array of workflow step nodes
Map of edges connecting workflow nodes
Description of the workflow
Current version number of the workflow
ID of the current workflow version
JSON schema defining the workflow's input variables
Schema defining vault credentials and their configuration
Whether popup handling is enabled for this workflow
Whether XPath recovery is enabled for this workflow
Whether node descriptions are auto-enriched for reliability improvements
Whether error code generation is enabled for this workflow
Whether service unavailable recovery is enabled for this workflow
Whether incorrect form input recovery is enabled
Whether password update recovery is enabled. When a site forces a password change, the Maintenance Agent classifies the error and sends a notification.
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.
Whether action timing recovery is enabled for this workflow
ID of the catalog workflow this was forked from (if applicable)
Version number of the catalog workflow this was forked from
Specific origin catalog workflow version ID used as the base
Base version number used when deriving from a catalog workflow
Whether to track updates from the origin catalog workflow
Whether network listener capture is enabled for this workflow version
Whether UDP proxying is skipped for this workflow version