When to use it
Start here whenever you’re building a new API workflow from scratch. If you’re building a variant of an existing journey, consider base templates and overlays instead.Key concepts
- Journey — an executable API workflow made up of one or more steps.
- Step — a single unit of work in a journey. Currently, steps support HTTP request steps only.
- Request template — a reusable definition of an HTTP request that steps pull from. The template defines the request shape; the journey defines how requests are sequenced and validated.
- Build artifact — the compiled output of a journey, used for execution. Created automatically when you run.
How it works
Open the journey list
From the sidebar, navigate to Journeys. Click New journey to open the creation dialog.
Name the journey
Give the journey a clear, descriptive name. You can update the name, description, owner, and tags later in the Details panel.
Add your first step
On the canvas, click Add step. Select a request template from the library. The step inherits the template’s request shape — endpoint, method, headers, and body structure.
Configure step values
Each step needs values for the inputs its request template expects. You can supply them as run inputs, variables, hard-coded values, or secret references. See the Values panel for the full picture.
Add more steps
Repeat the previous two steps for each request in the workflow. You can use step outputs from earlier steps as inputs to later ones — useful for chaining requests (e.g., use a created resource’s
id in the next request).Run the check
Open the Run check panel to review any errors or warnings. Errors must be resolved before the journey can run. Warnings flag incomplete setup or potential risks.
Examples
A simple two-step journey might:- Call
POST /ordersto create an order, using run inputs for customer ID and item details. - Call
GET /orders/{id}using theidderived from step 1’s response.
Related pages
Build mode
Overview of the Build-mode canvas and side panels.
Values panel
Configure the inputs and variables your journey needs.
Run check
Catch errors before your first run.
Base template and overlays
Build variants without duplicating journey definitions.

