We aim to provide accurate and helpful details about third‑party tools, but we can’t guarantee that this information is always complete or up to date. If you notice any discrepancies, feel free to share them in the feedback section below. For the most reliable information, please always refer to the third‑party tool’s official documentation.
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
Connections
API Key
API Key connection
If an API Key connection is supplied, an Authorization: Basic ${APIKEY} header is used in the HTTP request.
| Input | Comments | Default |
|---|---|---|
| API Key | API Key | |
| Authentication Scheme | The authentication scheme to use | Basic |
Basic Username/Password
Basic Username and Password connection
If a Basic Auth connection is supplied, an Authorization: Basic ${base64(USERNAME:PASSWORD)} header is used in the HTTP request.
| Input | Comments | Default |
|---|---|---|
| Username | Username | |
| Password | Password |
OAuth 2.0 Authorization Code
OAuth 2.0 Authorization Code flow
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.
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.
| Input | Comments | Default |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for the API | |
| Token URL | The OAuth 2.0 Token URL for the API | |
| Scopes | Space separated OAuth 2.0 permission scopes 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 |
OAuth 2.0 Client Credentials
OAuth 2.0 Client Credentials flow
This connection uses OAuth 2.0, a common authentication mechanism for integrations.
Read about how OAuth 2.0 works here.
| Input | Comments | Default |
|---|---|---|
| Token URL | The OAuth 2.0 Token URL for the API | |
| Scopes | Space separated OAuth 2.0 permission scopes 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 token requests |
Actions
GraphQL Request
Issue a generic GraphQL request
| Input | Comments | Default |
|---|---|---|
| Connection | ||
| GraphQL Endpoint | The endpoint of the GraphQL API | |
| Query or Mutation | query ($customerName: String!) { customers(name: $customerName) { nodes { id labels users { nodes { id } } } } } |
|
| Variables | Variables to pass in to your query or mutation | |
| Headers | Custom headers to send along with your request | |
| Debug Request | When true, the entire request and response (including auth headers) will be logged out. | false |