ToolJet/docs/versioned_docs/version-2.18.0/data-sources/graphql.md
Shubhendra Singh Chauhan 9f2ff94a12
[docs] platform 5.x (#7427)
* whtie label revamp

* minor changes

* updated beta info in copilot docs

* renamed gds to ds in overview doc of v2.15 onwards

* updated multienv: renamed gds to ds, updated screenshot

* updated multienv: app state description

* updated superadmin wrt new licensing updates

* licensing update: free trial

* updates in licensing

* changes after review

* [docs]updated restapi with bearer auth

* Update kubernetes-aks.md

* Update openshift.md

* Update ecs.md

* Update ecs.md

* Update kubernetes-gke.md

* Update kubernetes.md

* Update docker.md

* Update docker.md

* Update ecs.md

* Update google-cloud-run.md

* Update kubernetes-aks.md

* Update kubernetes-gke.md

* Update kubernetes.md

* Update openshift.md

* Update kubernetes-gke.md

* Update kubernetes-aks.md

* fixed ecs, removed heroku from 2.15 onwards

* updated digitalocean doc

* licensing doc changes and location

* Update digitalocean.md

* Update digitalocean.md

* added v2.18.0

---------

Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
2023-09-27 12:24:39 +05:30

2 KiB

id title
graphql GraphQL

ToolJet can establish connections with GraphQL endpoints, enabling the execution of queries and mutations.

Connection

To establish a connection with the GraphQL global datasource, you can either click on the Add new global datasource button located on the query panel or navigate to the Global Datasources page through the ToolJet dashboard.

ToolJet - Data source - REST API

ToolJet requires the following to connect to a GraphQL datasource:

  • URL: URL of the GraphQL endpoint
  • Headers: Any headers the GraphQL source requires
  • URL parameters: Additional query string parameters
  • Authentication Type: The method of authentication to use with GraphQL requests. Supported Types: None, Basic, Bearer, and OAuth 2.0
    • Basic: Requires Username and Password
    • Bearer: Requires a token, typically a JSON Web Token (JWT), to grant access
    • OAuth 2.0: The OAuth 2.0 protocol mandates the provision of the following parameters: access token URL, access token URL custom headers, client ID, client secret, scopes, custom query parameters, authorization URL, custom authentication parameters, and client authentication.

Querying GraphQL

Click on +Add button of the query manager at the bottom panel of the editor and select the GraphQL global datasource added in previous step.

Required Parameters:

  • Query

Optional Parameters

  • Variable
  • Headers
ToolJet - Data source - GraphQl

Click on the Create button to create the query or Click on the Run button to create and trigger the query.

:::tip Query results can be transformed using transformations. Read our transformations documentation to see how: link :::