GraphQL | Bricks Dag, Inc. Help Center

The GraphQL Processor is used to execute GraphQL queries, mutations, and subscriptions. GraphQL is a data query and manipulation language for APIs that allows clients to retrieve or modify data using more intuitive and flexible syntax.

If you are not familiar with GraphQL, it is recommended to first review the official documentation or tutorial videos to understand its fundamentals.

Local Sync Section

RunMode

one of

List

When a display device has Local Sync enabled in the DEVICE settings, and the devices are running the same application within the same local network, you can configure how this processor is executed:

all: All devices execute the processor when triggered.
main-only: Only the device with the highest priority in Local Sync executes the processor when triggered.
minor-only: Only the device with the lowest priority in Local Sync executes the processor when triggered.

Properties Section

init

Boolean

Boolean value

Configure whether the processor should start executing immediately after initialization.

Connection information

Type	One Of List	Configure the GraphQL request type Query: Retrieve data based on specified conditions. Mutation: Modify data based on specified conditions. Subscription: Subscribe to data updates based on specified conditions.
Headers	Object Object	Configure the HTTP request headers in standard HTTP format.
Endpoint	String Text string	Configure the HTTP request URL endpoint.
Endpoint For Subscription
Connection Params

GraphQL Content Section

Query	String Text string	Configure the content of the GraphQL query.
Variables	OneOf List
Data ID From Object	String Text string	Data id from response, it is useful for caching data

Use Firebase Section

Use GraphQL to interact with Firebase Realtime Database. For details, please refer to the apollo-link-firebase documentation.

Enabled	Boolean Boolean value Yes/No	Enable Firebase link Enable Firebase connection.
API Key	String Text string	Firebase API Key API key for Firebase.
Auth Domain	String Text string	Firebase Realtime Database `authDomain` field The `authDomain` field of the Firebase Realtime Database.
Database URL	String Text string	Firebase Realtime Database `databaseURL` field The `databaseURL` field of the Firebase Realtime Database.
Project ID	String Text string	Firebase Realtime Database `projectId` field The `projectId` field of the Firebase Realtime Database.
Storage Bucket	String Text string	Firebase Realtime Database `storageBucket` field The `storageBucket` field of the Firebase Realtime Database.
Messaging Sender Id	String Text string	Firebase Realtime Database `messagingSenderId` field The `messagingSenderId` field of the Firebase Realtime Database.

Events Section

Subscription on Connection	Triggered when the subscription connection is successfully established.
Subscription on Connection Error	Triggered when a GraphQL subscription connection error occurs.

Outlets Section

Response	The result of the GraphQL request, returned in object format.
Error	Error messages returned by the GraphQL server, in object format.

Operation Section
- Inspect this Generator
  View the relationship flow between this Generator and its connected Events and Property Bank variables.
- Event Routing
  Display the flow of triggered events or calculations, showing which Bricks, Generators, or Properties are affected. This is useful for verifying whether there are issues in the event connections between processors and components.
- Parent Call
  Display which Bricks, Generators, or Property Calculations have triggered or are linked to this Generator. Unlike Event Routing, which shows downstream paths, Parent Call inspects the upstream sources.
- Copy
  Duplicate this Generator.
- Remove this Generator
  Delete this Generator.