Cognidata GraphQL
An Ignition module that adds a gateway-side GraphQL client: configurable GraphQL connections plus system.cognidata.graphql.* scripting functions, callable from both the gateway and the Designer.
This is a pure gateway + scripting module — it has no Perspective component and no web build.
Get started with the tutorial Function reference
What it gives you
Connections are configured once in the gateway and then called from scripts by name, so endpoints and credentials stay out of your project code and never leave the server.
result = system.cognidata.graphql.query(
"warehouse-api",
"query($code: ID!) { country(code: $code) { name capital } }",
variables={"code": "US"},
)
country = result["data"]["country"]
| Central configuration | Endpoints, auth, headers, timeouts and TLS settings live in one gateway config page. |
| Four auth modes | NONE, BEARER, BASIC, or a custom HEADER. Secrets are stored encrypted. |
| Gateway + Designer | The same system.cognidata.graphql namespace exists in both. Designer calls are forwarded over module RPC and execute on the gateway. |
| Live health checks | A background heartbeat probes { __typename } on every enabled endpoint every 30 seconds and surfaces the result in the connections table. |
Where to go next
- Tutorial — from a freshly installed module to a working query, using a free public API so you can follow along without credentials.
- Connections — every setting on the connection config page, and what the status column means.
- Scripting reference — function signatures, return shapes, error behavior, and troubleshooting.
Requirements
- Ignition 8.1 or later
- The module installed and Running under Config → Modules
Project layout
common # AbstractGraphqlScriptModule, GraphqlRpc, module identity (scope: GD)
gateway # GraphqlGatewayHook, connection config page + record, GraphqlClient, heartbeat (scope: G)
designer # GraphqlDesignerHook + RPC-forwarding scripting module (scope: D)