Skip to main content
Sends a request to a GraphQL API and places the response into the data. GraphQL APIs let you ask for exactly the fields you need in a single query, so this is handy for enriching the data mid-route, for example fetching a product with just its name and price. It works the same way as the HTTP request step, but the request body is a GraphQL query written in a dedicated editor. By default the response replaces the data flowing through this step, so the next steps work with what the API returned.

Fields

Sample data

This step makes a live GraphQL call, so the result depends on the endpoint you call. The example below fetches a product by id with a POST request, using a placeholder to insert the id from the data into the query. The GraphQL response replaces the data.
FieldValue
Request URIhttps://example.org/graphql
Request MethodPOST
Request Parametersthe query below
{
    product(id: "&{identifier}") {
        identifier
        name
        price
    }
}
A typical response then replaces the data:
{
    "identifier": 1234,
    "name": "Red T-Shirt M",
    "price": 19.95
}
To keep both your original data and the response, follow this with a merger step. See Placeholders for how to reference values such as &{identifier} in the query.