GraphQL Component

Make GraphQL requests (queries and mutations) to a GraphQL-based API

Component key: graphql

Description

The GraphQL component allows you to make requests to a GraphQL-based API.

API Documentation

For further information on GraphQL please refer to the following guide: Introduction to GraphQL

GraphQL Authentication

You can use the built-in connection types to connect to a standard GraphQL API with basic auth, API key or OAuth 2.0. If the API that you're connecting to uses non-standard authentication (for example, it uses a header named X-API-Key), you can pass in authentication information through the header input.

Connections

API Key

If an API Key connection is supplied, an Authorization: Basic ${APIKEY} header is used in the HTTP request.

Input	Default	Notes
API Key string / Required apiKey		API Key
Authentication Scheme string / Required authScheme	Basic	The authentication scheme to use

OAuth 2.0 Authorization Code

If an OAuth 2.0 connection are supplied, an Authorization: Bearer ${KEY} header is used in the HTTP request, where KEY is the client key that is fetched from the OAuth provider.

Input	Notes
Authorize URL string / Required authorizeUrl	The OAuth 2.0 Authorization URL for the API
Client ID string / Required clientId	Client Identifier of your app for the API
Client Secret password / Required clientSecret	Client Secret of your app for the API
Headers string Key Value List headers	Additional header to supply to authorization requests
Scopes string scopes	Space separated OAuth 2.0 permission scopes for the API
Token URL string / Required tokenUrl	The OAuth 2.0 Token URL for the API

Basic Username/Password

If a Basic Auth connection is supplied, an Authorization: Basic ${base64(USERNAME:PASSWORD)} header is used in the HTTP request.

Input	Notes
Password password / Required password	Password
Username string / Required username	Username

OAuth 2.0 Client Credentials

Input	Notes
Client ID string / Required clientId	Client Identifier of your app for the API
Client Secret password / Required clientSecret	Client Secret of your app for the API
Headers string Key Value List headers	Additional header to supply to token requests
Scopes string scopes	Space separated OAuth 2.0 permission scopes for the API
Token URL string / Required tokenUrl	The OAuth 2.0 Token URL for the API

Actions

GraphQL Request

Issue a generic GraphQL request | key: graphqlRequest

Input	Default	Notes	Example
Connection connection connection
Debug Request boolean / Required debug	false	When true, the entire request and response (including auth headers) will be logged out.
GraphQL Endpoint string / Required endpoint		The endpoint of the GraphQL API	https://api.example.com/graphql
Headers string Key Value List headers		Custom headers to send along with your request
Query or Mutation code / Required query
Variables string Key Value List variables		Variables to pass in to your query or mutation

---