1. What Are Workflows? #
Workflows allow you to design end-to-end integration tests by chaining multiple API calls, validations, and logic steps into a single execution flow.
Unlike single test cases, workflows simulate real user journeys, system interactions, and multi-step business processes.
2. Who Should Use Workflows? #
Workflows are ideal for:
- QA teams testing complete business scenarios
- Automation engineers validating multi-service integrations
- DevOps teams running CI/CD regression pipelines
- Teams testing authentication → transaction → logout flows
3. Workflows Dashboard #
3.1 What You Can Do #
From the Workflows page, users can:
- Create new integration tests
- Run selected workflows
- Delete or edit workflows
- Search and filter existing workflows
- View execution status and last run details
3.2 Workflow List View #
Each workflow shows:
| Field | Description |
|---|---|
| Test Name | Workflow name |
| Status | Last run result (Passed/Failed) |
| Last Run | Timestamp of last execution |
| Description | Optional context |
| Actions | Run, View, Edit, Clone, Delete |
4. Workflow Builder Interface #
4.1 Canvas Area #
The central grid where workflows are visually constructed using nodes and connections.
4.2 Left Panel (Node Library) #
Categories include:
- Node Types – API request blocks
- System Blocks – Start, Stop, Flow controls
- Variables & State – Store and reuse data
- Data Operations – Transform or manipulate responses
- Advanced Control Flow – Conditions, loops, branches
- Assertions & Validation – Verify responses
- Execution Control – Timing, retries
- Utilities – Supporting operations
4.3 Workflow Controls #
| Control | Purpose |
|---|---|
| Launch Workflow | Execute immediately |
| Save | Save workflow design |
| Close | Return to list view |
5. How to Create a Workflow #
5.1 Start Node #
Every workflow begins with Start — the entry point.
5.2 API Request Nodes #
Add API steps such as:
- POST /token (authentication)
- GET/POST business APIs
- Logout or cleanup calls
Each node includes:
- Endpoint
- Method
- Parameters
- Headers
- Authentication profile
5.3 Data Passing Between Steps #
Response fields from one step can be reused in another.
Example:
access_token from login → used in Authorization header for next request
5.4 Assertions & Validations #
Validate:
- Status code
- Response fields
- Schema
- Response time
Failures can branch the flow or stop execution.
5.5 Stop Node #
Marks the workflow end and determines final result.
6. Workflow Node Types #
| Node | Purpose |
|---|---|
| Start | Entry point |
| API Request | Call an endpoint |
| Variable Node | Store values |
| Assertion Node | Validate responses |
| Condition Node | Branch logic |
| Stop | End workflow |
7. Running a Workflow #
You can execute workflows:
- From the dashboard
- From inside the builder
- As part of scheduled runs
- Via CI/CD integrations
8. Workflow Execution Flow #
Start → Login API → Capture Token → Business API → Validate → Logout → Stop
Each step executes sequentially unless logic blocks define branching.
9. Use Cases for Workflows #
- Login → Purchase → Confirmation
- Multi-service integrations
- Regression testing critical paths
- Failure handling scenarios
- Data lifecycle validations
10. Best Practices #
- Keep workflows modular
- Use variables instead of hardcoding data
- Add assertions at each critical step
- Handle failure paths explicitly
- Use environment-based authentication profiles
11. What You Can Expect from Workflows #
With Workflows, teams can:
Test real user journeys
Validate service integrations
Reduce production defects
Automate business-critical flows
Achieve deeper test coverage
