DocumentationWorkflowsApps and services
GraphQL node
Send a GraphQL query or mutation with variables to an endpoint and return `data` / `errors`. A thin specialization of the HTTP block. Learn how to configure it, map inputs and outputs, run a test and resolve common errors.
8 min readUpdated
What this node does
Send a GraphQL query or mutation with variables to an endpoint and return `data` / `errors`. A thin specialization of the HTTP block.
Use GraphQL as a clearly defined step in an anymize workflow.
- Processes one input.
- Provides one output for following steps.
- Runs as a regular step in the flow.
Set up the node
- 01Open a workflow and add GraphQL from the node catalog.
- 02Complete the required fields and map values from previous steps.
- 03Run the node with a small test record and inspect its output.
- 04Connect the successful output and activate the workflow after an end-to-end test.
Operations and modes
GraphQL has one focused purpose. Its available settings appear when you select the node.
Settings
| Field | Meaning | Area |
|---|---|---|
| Endpoint URL | Configure this value in the node panel. | Standard |
| Query / Mutation | Configure this value in the node panel. | Standard |
| Variables (JSON) | Configure this value in the node panel. | Standard |
| Authentication | Choices: None, Bearer token, API key (header), Basic Auth | Standard |
| Credentials from workflow secret | Pick the workflow secret containing the token, API key, or Basic Auth password. Plaintext never enters the workflow JSON. | Protected |
| Key field name | Configure this value in the node panel. | Standard |
| Username | Configure this value in the node panel. | Standard |
| Headers | Configure this value in the node panel. | Standard |
| Run once per item | Off (default): the node runs once for the whole input. On: if it receives several items (e.g. from Split Out), it runs once PER item, and {{ $json }} is that one item each time. This is how you work through a file list entry by entry. | Standard |
| If one item fails | "Skip" writes an `error` field for the failed item and keeps processing the rest, instead of losing the whole run to a single unreadable file. | Standard |
| Pause between items (milliseconds) | Wait before every run except the first. 1000 = 1 second per item. Useful when the other side would otherwise throttle you. Maximum 300000 (5 minutes). | Standard |
Inputs and outputs
| Input | Meaning | Type |
|---|---|---|
| Standard | Receives the complete result from the previous step. | JSON |
| Output | Meaning | Type |
|---|---|---|
| response | Configure this value in the node panel. | json |
| status | Configure this value in the node panel. | number |
| ok | Configure this value in the node panel. | boolean |
This node can process lists item by item. Error handling and the delay between items are available in advanced settings.
Example and test run
Test-run example: begin with a small, recognizable record. Inspect the output and only map fields that are present there.
Test-run example
{
"input": "value"
}Access and security
Before activation, review which data enters this step and what its output contains.
Store keys and credentials in the protected connection manager. Never paste them into normal workflow fields, test data or descriptions.
Troubleshooting
- No output: inspect the latest run and confirm that the previous node returned the expected fields.
- Empty variable: open the previous step output and use a field name from the real test data.
- List processed once: enable per-item execution in advanced settings.