GraphQL Request

Executes GraphQL queries and mutations against any GraphQL endpoint, supporting Basic, Bearer, or OAuth authentication and schema-driven templates generated from introspection.

Revision History

1.0.0.0 - 2025/10/30 - Initial release.
1.0.1.1 - 2026/01/20 - Fixed shared OAuthConnection lock handling.
1.0.1.2 - 2026/01/21 - Changed template key format for AI system.

Setup Notes

1. Obtain the base URL for your GraphQL endpoint (for example, https://api.example.com/graphql) and ensure introspection is permitted.
2. Choose an authentication method supported by the endpoint (None, Basic, Bearer token, or OAuth). When using OAuth, provide Auth URL, Token URL, Client ID, Secret Key, and Scope.
3. Add any required custom headers (for example, tenant or API keys) to Custom Headers in Key: Value format, one per line.
4. Provide an Authentication Test Query that can run safely during connection testing (for example, a lightweight query against a health or version field).
5. Click Acquire Metadata on the connection to run the standard GraphQL introspection query and cache the schema. Templates for queries and mutations rely on this cached schema.
6. Adjust Maximum Object Depth if the autogenerated templates are too shallow or too verbose; the default depth is 5.

Connection

Parameter	Type	Description
URL	String	Base URL of the GraphQL endpoint (for example, https://api.example.com/graphql).
Authorization	Enum	Authentication mode: None, Basic, Bearer, or OAuth.
Username	String	Username for Basic authentication.
Password	Masked	Password for Basic authentication.
Bearer Token	Masked	Token for Bearer authentication.
Auth URL	String	OAuth authorization URL (OAuth mode only).
Token URL	String	OAuth token endpoint URL (OAuth mode only).
Client ID	Masked	OAuth client identifier (OAuth mode only).
Secret Key	Masked	OAuth client secret (OAuth mode only).
Scope	String	OAuth scopes requested during authentication (OAuth mode only).
Access Token	Masked	OAuth access token (populated after authentication).
Refresh Token	Masked	OAuth refresh token (populated when provided by the identity provider).
Custom Headers	String	Additional headers in Key: Value format, one per line.
Authentication Test Path	String	Optional path appended to the base URL for connection testing.
Authentication Test HTTP Method	Enum	HTTP method to use during connection tests.
Authentication Test Query	String	GraphQL query executed during connection testing (required to test).
Schema	String	Cached introspection schema populated by Acquire Metadata.
Maximum Object Depth	Integer	Depth limit for autogenerated templates (default: 5).

Functions

Query

Parameter	Type	Notes
Connection	Connection	Connection profile containing endpoint URL, authentication, and cached schema.
Query	String	GraphQL query document to execute.
Body	IAsyncEnumerable	Optional variable payloads; if omitted, the query executes once with no variables.

Return	Type	Notes
Response	IAsyncEnumerable	GraphQL responses. Errors are returned in the errors array within each response.

Mutation

Parameter	Type	Notes
Connection	Connection	Connection profile containing endpoint URL, authentication, and cached schema.
Query	String	GraphQL mutation document to execute.
Body	IAsyncEnumerable	Optional variable payloads; if omitted, the mutation executes once with no variables.

Return	Type	Notes
Response	IAsyncEnumerable	GraphQL responses. Errors are returned in the errors array within each response.

Known Issues

• Introspection must be enabled on the endpoint to acquire metadata and generate templates.
• GraphQL errors are returned in the errors array of the response; the node does not throw for application-level GraphQL errors during normal execution.