Launch GraphOS Studio

GraphQL subscriptions in the Explorer

The provides support for executing using a variety of protocols (including WebSocket and HTTP). You can configure the Explorer to use whichever protocol your GraphQL endpoint requires.


To execute a in the , first open the Explorer's Connection settings to specify your endpoint and implementation:

Subscription settings in the Explorer


Remember that the path and protocol of your URL might differ from those of your primary endpoint.

Executing a subscription

You define a in the Explorer's Operation panel, just as you do for a or :

Example subscription operation in the Explorer

When you run the , a Subscriptions panel appears in the bottom right that updates as new data arrives:

Subscriptions panel in the Explorer
  • The most recently received payload is displayed at the top of the panel.
  • The dot next to STATUS indicates whether the Explorer is connected to your endpoint (green if connected, red if disconnected).
  • Click the X next to Listening to stop listening for updates. The updates you've already received remain in the panel.
  • Click the X next to Subscriptions to close the panel entirely.

Troubleshooting connection issues

If you can't connect to your endpoint, double-check all the following in the Explorer's Connection settings:

  • The protocol of your endpoint URL (ws/wss for WebSocket, http/https for HTTP)
  • The path of your endpoint URL
  • Your selected implementation (see Setup)
Sandbox (no account required)
Connecting and authenticating
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy