Flows
Flows let you define multi-step API workflows that chain triggers and actions together. Use flows to simulate complex scenarios like payment callbacks, webhook chains, or delayed responses.
Creating a Flow
Section titled “Creating a Flow”- Open a project
- Click Create Flow
- Enter a Name (e.g., “Stripe Payment Flow”)
- Optionally add a Description
- Add one or more steps
- Click Create Flow
Each flow consists of one or more steps. A step pairs a trigger (when to run) with an action (what to do).
Trigger Types
Section titled “Trigger Types”| Trigger | Description | Configuration |
|---|---|---|
| When request hits | Fires when a specific endpoint receives a request | Select an endpoint |
| After delay | Fires after a configurable delay | Delay in milliseconds |
| After step | Fires after another step in the flow completes | Select a step |
Action Types
Section titled “Action Types”| Action | Description | Configuration |
|---|---|---|
| Return mock response | Sends the configured mock response for an endpoint | Select a mock endpoint |
| Send callback (HTTP) | Makes an outbound HTTP request to an external URL | HTTP method and URL |
| Proxy forward | Forwards the request through a proxy endpoint | Select a proxy endpoint |
Adding Steps
Section titled “Adding Steps”- In the flow editor, click + Add Step
- Select a trigger type and configure it
- Select an action type and configure it
- Optionally add a label to identify the step
Steps are displayed in order with a visual timeline connector.
Enable and Disable
Section titled “Enable and Disable”Flows can be toggled on or off. A disabled flow does not execute when its triggers fire. Toggle the flow’s Enabled state from the flow list.
Editing a Flow
Section titled “Editing a Flow”- Click on an existing flow to open the editor
- Modify the name, description, or steps
- Click Save Changes
Deleting a Flow
Section titled “Deleting a Flow”- Select a flow from the list
- Click Delete
- Confirm the deletion
Example: Webhook Callback
Section titled “Example: Webhook Callback”Simulate an API that accepts a payment and sends a webhook callback after processing:
- Step 1: Trigger = “When request hits” on
POST /payments, Action = “Return mock response” (202 Accepted) - Step 2: Trigger = “After delay” (2000ms), Action = “Send callback” (POST to
https://yourapp.com/webhooks/payment)
This returns an immediate 202 response, then sends a callback 2 seconds later — matching how real payment APIs behave.