Skip to main content

Connecting to WebSockets via Postman UI

This tutorial will guide you through connecting to a WebSocket using Postman and sending a subscription message.

Step 1: Open Postman​

Ensure you have Postman installed and opened on your system. If you don’t have it yet, download it from Postman’s official website.

Step 2: Create a New WebSocket Request​

  1. In Postman, click on File > New... > WebSocket. pe_1
  2. Enter the WebSocket URL in Enter URL field : wss://rest-mainnet.onflow.org/v1/ws or wss://rest-testnet.onflow.org/v1/ws
  3. Click Connect button to establish the WebSocket connection. pe_2

Step 3: Send a Subscription Message​

  1. Once connected, go to the Messages tab.
  2. Enter the JSON message into the text box. In this example the digests block subscription will be established. For other available topics check Supported topics page.
  3. Click Send to subscribe to the WebSocket topic. pe_3

Step 4: View Responses​

  • After sending the message, you should start receiving responses in the Response bottom tab.
  • Each message received from the server will be displayed in real-time.

pe_4

Step 5: Disconnect​

  • When you are done, click Disconnect to close the WebSocket connection.

Troubleshooting​

  • Ensure WebSocket URL is correct and active.
  • In case of an error validate your JSON message for any syntax errors before sending and check correctness of all arguments on Supported topics page.

Congratulations! You have successfully connected to a WebSocket server using Postman and sent a subscription message.

Rate this page