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 | Notes | Example |
|---|---|---|
| API Key | API Key | |
| Authentication Scheme | The authentication scheme to use | Basic |
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 | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for the API | |
| Client ID | Client Identifier of your app for the API | |
| Client Secret | Client Secret of your app for the API | |
| Headers | Additional header to supply to authorization requests | |
| Scopes | Space separated OAuth 2.0 permission scopes for the API | |
| Token URL | 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 | Example |
|---|---|---|
| Password | Password | |
| Username | Username |
OAuth 2.0 Client Credentials
| Input | Notes | Example |
|---|---|---|
| Client ID | Client Identifier of your app for the API | |
| Client Secret | Client Secret of your app for the API | |
| Headers | Additional header to supply to token requests | |
| Scopes | Space separated OAuth 2.0 permission scopes for the API | |
| Token URL | The OAuth 2.0 Token URL for the API |
Actions
GraphQL Request
Issue a generic GraphQL request | key: graphqlRequest
| Input | Notes | Example |
|---|---|---|
| Connection | ||
| Debug Request | When true, the entire request and response (including auth headers) will be logged out. | false |
| GraphQL Endpoint | The endpoint of the GraphQL API | https://api.example.com/graphql |
| Headers | Custom headers to send along with your request | |
| Query or Mutation | ||
| Variables | Variables to pass in to your query or mutation |