Sage X3 GraphQL

Provides integration into Sage X3 via its GraphQL API.

Revision History

1.0.0.0 Initial Release
1.0.0.2 Added Query operation to get node samples
1.0.0.3 Fixed validation issue when connection not set.

Properties

Connection

Type: Connection Input
The Connection Property containing credentials for Sage X3.

ConnectionType
Type: Enum
The type of authentication to use:

• Basic
• JwtToken

Username
Type: String
Basic authentication username.

Password
Type: Secret
Basic authentication password.

ClientId
Type: String
The Client ID for your Sage X3 connected app.

ClientSecret
Type: Secret
The Client Secret for your Sage X3 connected app.

User
Type: String
(Optional) Username to include as the JWT subject (sub) claim. Leave blank if not required by your Sage X3 configuration.

Audience
Type: String
Audience value for the JWT token, typically the full GraphQlEndpoint.

GraphQlEndpoint
Type: String
The base URL of your Sage X3 GraphQL API endpoint.

Endpoint
Type: String
The identifier of the Sage X3 endpoint to target within the GraphQL API.

Operation

Type: Enum Input
Select the GraphQL operation type: ‘Query’ or ‘Mutation’.

Object

Type: String Input
The root GraphQL object to target, specified using dot-separated path notation for nested fields.

SelectionSet

Type: String Input
The GraphQL selection set string defining the fields to return.

Request

Type: JSON Input (Mutation only)
The JSON payload containing input data for mutations.

Setup

To use this node, you need to create a Connected App in your Sage X3 environment. This app provides the credentials necessary for JWT authentication when calling the GraphQL API.

Follow the official Sage X3 guide to create a connected app and obtain the Client ID, Client Secret, Issuer, and Audience values required for authentication:
Creating a connected application to authenticate requests.

Enter these credentials into the Connection property of the node.

Endpoint

This value is sent as the custom HTTP header x-xtrem-endpoint in every request and directs the server which internal X3 endpoint to route the request to. Typically configured in Sage X3’s Connected Application settings (e.g., "PROD", "TEST").

Remarks

• The ‘Object’ property supports dot-separated paths to simplify nested GraphQL queries.

Selection Set Spacing

Use consistent indentation for nested fields in the selection set, either with tabs or four spaces.

Nested Arguments

Nested arguments in queries are supported via dot-path notation (e.g., items.first). The node generates custom properties accordingly when a sample is selected