GraphQL

GraphQL

Certified

Tasks that send GraphQL queries and mutations over HTTP endpoints.

Define the GraphQL url, query, and optional variables or custom headers to call APIs, with responses returned as JSON you can store, filter, or pass to downstream tasks.

How to use the GraphQL plugin

Execute GraphQL queries and mutations from Kestra flows.

Authentication

Set uri to your GraphQL endpoint. Pass authentication credentials via headers (e.g. an Authorization bearer token) or via options.auth for basic auth. Store secrets in secrets and apply connection properties globally with plugin defaults.

Tasks

Request executes a GraphQL operation — set query (required, the GraphQL query or mutation string). Pass runtime values via variables (a map) and set operationName when the document contains multiple operations. The request uses POST by default; set method to override. Set failOnGraphQLErrors: true to fail the task when the response contains GraphQL errors (default is false — errors are surfaced in the error output field). The output includes body (the data field), error, code, and headers.

Create automations with GraphQL Plugin