Connectors

GraphQL Connector

Make a GraphQL query or mutation against any GraphQL endpoint with variables and headers — a generic passthrough, not wired to a specific API.

On this page

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

What this connector is for

Makes a GraphQL request (query or mutation) against any GraphQL endpoint you supply — a generic passthrough in the same spirit as the HTTP Connector, but scoped to GraphQL's POST-with-a-query-string convention rather than arbitrary REST. It isn't wired to any specific internal or third-party GraphQL API — you provide the endpoint URL, the query/mutation text, and any variables.

Under the hood, every request is a POST with Content-Type: application/json (overridable via Headers) and a JSON body of {query, variables, operationName} — the standard GraphQL-over-HTTP convention most GraphQL servers expect.

GraphQL Query

Configuring it

GraphQL Endpoint URL — required. Must start with http:// or https://.

GraphQL Query/Mutation — required. The full query or mutation text, e.g.:

query GetUser($id: ID!) {
  user(id: $id) {
    id
    name
    email
  }
}

Variables — optional. A JSON object of GraphQL variables referenced in the query via $variableName, e.g. {"id": "123"}.
Operation Name — optional; required by some servers when the Query field contains more than one named operation.
Headers — optional key/value pairs, e.g. Authorization: Bearer {{connection.token}}. Content-Type: application/json is set by default and can be overridden here.

Reading the response

The full GraphQL response body ({data, errors, extensions}) is placed under response.data — one level deeper than a typical REST response, since GraphQL's own body already has a data key:

{{<stepReference>.response.data.data.<field>}} — the GraphQL query/mutation result, e.g. {{<stepReference>.response.data.data.user.name}}.
{{<stepReference>.response.data.errors}} — GraphQL errors, if any (a GraphQL error doesn't necessarily mean a non-2xx HTTP status — check both).
{{<stepReference>.response.data.extensions}} — server-specific extensions, if any.
{{<stepReference>.response.status}} — the HTTP status code of the request itself.
{{<stepReference>.response.headers.<header-name>}} — a response header.

For example, a step named "Get User" (reference getUser) running the query above — use {{getUser.response.data.data.user.name}} for the result, or {{getUser.response.data.errors}} to check for GraphQL-level errors.

Example

GraphQL Endpoint URL: https://api.example.com/graphql
GraphQL Query/Mutation:
  query GetUser($id: ID!) {
    user(id: $id) {
      id
      name
      email
    }
  }
Variables: {"id": "123"}
Operation Name: GetUser

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.