Workflows

What a workflow is

A workflow is a named container for one or more routes. Each route pairs a trigger (what starts it — an incoming API call, a schedule, a webhook, etc.) with an ordered sequence of steps (connector actions) that run in response.

Creating a workflow

• Name — required. A human-readable name shown throughout the app (e.g. "Cart Management").
• Slug — required, auto-generated from the name but editable. Must be unique within the store, and may only contain lowercase letters, numbers, and hyphens.
• Description — required. What the workflow does.
• Rate limiting — optional. When enabled, caps requests to limit (1–10,000) per windowSeconds (1–60). This only applies to published workflows — test executions are never rate-limited.

After creating it

You land in the workflow builder for the new, empty workflow. From there:

• Add a route — each route has its own trigger and step sequence, and is either public (no auth required) or private (requires an API key or JWT, configured on the route).
• Choose a trigger — API endpoint, GraphQL, webhook, schedule, or file event.
• Add steps — each step is a connector action. See Step Name for how steps are named and Step Reference for how to use one step's output in a later step.
• Add variables — typed values (string, secure-string, integer, float, boolean, json, array, map, connection, schedule) a workflow's steps can reference, including credentials and connections.

A route's steps don't run for real traffic yet at this point — that only happens once the workflow is published and deployed to an environment, and each environment gets its own independent live instance.

The AI Assistant available inside the workflow builder can also build and edit routes/steps for you from a plain-language description.