Connectors

Invoke Workflow Connector

Invoke another workflow in the same store, synchronously, passing method/path/headers/body/query and reading its result — always in the same environment as the calling execution.

On this page

What this connector is for Invoke Workflow Configuring it Reading the response Example Step Name Step Reference Execution Settings Caching Locking

What this connector is for

Invokes another workflow in the same store, synchronously, as a step in the current one — passing it a method/path/headers/body/query just like an incoming HTTP request, and waiting for its result before moving on. Use it to share logic across workflows (e.g. a common "Send Notification" workflow called from several others) without duplicating steps. For calling a different route within the same workflow instead, see Invoke Route.

The invoked workflow always runs in the same environment as the calling execution — its environment id is carried through execution context, not headers, so it can't be overridden by Forward All Headers or by any environment header on the original incoming request. If the target workflow hasn't been deployed to that environment, the call fails.

Invoke Workflow

Configuring it

Workflow Slug (workflowSlug) — required. The slug of the workflow to invoke, picked from your store's available workflows.
HTTP Method (method) — required, one of GET/POST/PUT/PATCH/DELETE. Defaults to POST. Matched against the target workflow's route trigger configuration, same as a real incoming request.
Request Path (path) — the path used for the invocation (e.g. /api/users), matched against the target workflow's routes. Defaults to /.
Forward All Headers (forwardAllHeaders) — boolean, default off. When on, every header from the original incoming request that triggered this execution is forwarded to the invoked workflow (case-insensitively normalized to lowercase keys), with one deliberate exception: x-request-environment-id is always stripped, since environment routing is handled separately and explicitly (see above). Headers set in the Headers field below always override a forwarded one with the same name.
Headers (headers) — key/value rows sent as request headers, applied after (and overriding) any forwarded headers.
Query Parameters (queryParams) — key/value rows appended to the request as query parameters.
Request Body (body) — a JSON string (or, if built programmatically, an object) sent as the request body for POST/PUT/PATCH. An invalid JSON string fails the step with a clear parse error rather than sending malformed data through.

Reading the response

The invoked workflow's own result lands under the normal response.data envelope, matching the connector's outputSchema:

{{<stepReference>.response.data.success}} — whether the invoked workflow completed successfully.
{{<stepReference>.response.data.data}} — the invoked workflow's own response body.
{{<stepReference>.response.data.status}} — the HTTP status code the invoked workflow's route responded with.
{{<stepReference>.response.data.executionId}} — the invoked workflow's execution id.
{{<stepReference>.response.data.childExecutionId}} / {{<stepReference>.response.data.childExecutionLabel}} — this connector's own addition (not part of the invoked workflow's response): a pointer to the invoked workflow's own persisted Execution record, so you (or the batch job log) can drill into its full step-by-step history from the execution detail view.

If the invoked workflow's route responds with an HTTP status of 400 or higher — or the invocation itself can't even start (unknown workflowSlug, missing store/workflow context) — this step is marked failed, and the failure surfaces the same way an HTTP Connector error does: {{<stepReference>.response.status}}, {{<stepReference>.response.statusText}}, {{<stepReference>.response.data.message}} (and .error/.code where available), plus {{<stepReference>.response.childExecutionId}} if a child execution did start before failing. Turn on Continue On Error (see Execution Settings) if the parent workflow should keep going regardless of the sub-workflow's outcome.

For example, a step named "Send Welcome Email" (reference sendWelcomeEmail) — use {{sendWelcomeEmail.response.data.data}} to read what the invoked workflow returned, or {{sendWelcomeEmail.response.status}} to check whether the call itself failed.

Example

Workflow Slug: send-welcome-email
Method: POST
Path: /notify
Body: {"email": "{{trigger.body.email}}", "firstName": "{{trigger.body.firstName}}"}

Also applies here

Step Name

What it's for

Every step in a workflow gets a name — either one you set or a default based on the connector and action (e.g. "Get Order Details", "Send Welcome Email"). It's shown throughout the UI and in your execution history, and it's also the source for the step's Reference — a camelCase identifier auto-generated from the name (e.g. "Get Order Details" → getOrderDetails) — which is what you actually use in {{...}} expressions to read this step's output from later steps. See Step Reference.

Rules

Must be at least 2 characters, and 50 characters or fewer.
Must be unique within the workflow — reusing a name that's already taken will be rejected, with a suggested alternative (e.g. "Get Order Details 2").
Can't be empty.

Tips

Prefer a descriptive, human-readable name over a generic one — "Get Order Details" is easier to work with later than "HTTP Request 2", especially once a workflow has a dozen steps.
Renaming a step updates every reference to it elsewhere in the workflow automatically.

Step Reference

Syntax

Any input field can reference earlier data using {{expression}}. The expression is evaluated as JSONata — so simple dot-paths and more advanced queries (filters, functions) both work.

Referencing a step's output

Use the step's Reference — a camelCase identifier auto-generated from its Name (e.g. "Get Order Details" → getOrderDetails), shown read-only wherever the step's fields are configured — followed by the field path. Elsewhere in these docs this general pattern is written as {{<stepReference>.field.path}}:

{{getOrderDetails.response.data.id}}
{{getOrderDetails.response.status}}

The raw display name won't work here even though it's what you see in the UI — {{Get Order Details.response.data.id}} isn't valid, since a bare name containing spaces isn't a single JSONata identifier. Always use the camelCase Reference.

You can also reference steps by position instead of by reference:

{{steps[0].response.data.id}}

Referencing trigger data

{{trigger.headers.authorization}}
{{trigger.body.customerId}}
{{trigger.query.page}}
{{trigger.params.orderId}}
{{trigger.method}}
{{trigger.path}}

Referencing workflow variables

{{variables.myVariable}}

See Variables for the full list of variable types and more examples, including connection-type variables.

Referencing runtime variables

A separate, mutable namespace written by the Variable connector while a run is in progress — not the same as the workflow-level variables above:

{{runtimeVariables.myVariable}}

Notes

If an expression can't be resolved (a typo in a step name, a field that doesn't exist), it resolves to an empty string rather than failing the workflow — check your execution history if a value comes through blank.
Object values are automatically JSON-stringified when interpolated into a string field.

Execution Settings

Fire-and-forget

When enabled, the workflow doesn't wait for this step to complete before moving to the next one. Use it for steps whose result nothing downstream depends on — logging, analytics, notifications — so they don't add latency to the steps that matter.

Continue on error

When enabled, a failure in this step doesn't stop the workflow — execution continues to the next step. The failure is still recorded in the execution history; this just controls whether it's fatal.

Combine the two for steps that are genuinely optional to the outcome: fire-and-forget so they don't add latency, continue-on-error so a failure in them (e.g. an analytics endpoint being briefly down) doesn't take down an otherwise-successful workflow run.

Caching

What it does

When enabled, a step's result is cached for a configurable TTL (time-to-live, in seconds). If the step runs again with the same effective cache key before the TTL expires, the cached result is returned instead of re-running the step.

Configuring it

Enabled — turn caching on or off for this step.
TTL — how long (in seconds) a cached result stays valid.
Cache key template — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same call". By default this is based on the step's resolved input; a custom template lets you cache more narrowly or broadly than that.

When to use it

Good candidates are steps that call something slow or rate-limited but return the same answer for the same input within a short window — a lookup against a rarely-changing external system, for example. Skip it for steps whose result must always be fresh (anything involving live inventory, pricing, or payment state).

Locking

What it does

When enabled, only one execution of this step (for a given lock key) can run at a time. If a second execution tries to run the same step while a lock is held, it waits until the lock is released or the hold period elapses.

Configuring it

Enabled — turn locking on or off for this step.
Lock key — an expression (supporting the same {{...}} step reference syntax used elsewhere) that determines what counts as "the same resource". By default the lock is scoped to the step itself; a custom key lets you lock per-customer, per-order, or any other identifier that needs serialized access.
Period — how long (in seconds) the lock is held before it's automatically released, in case an execution doesn't complete normally.

When to use it

Use it whenever concurrent executions could race on the same resource — e.g. two workflow runs both trying to update the same order's status at once. A lock key scoped to the order id ensures only one of them proceeds at a time.