Restfox · Example Payload

Restfox Websocket Example

Example of a WebSocket connection in Restfox for real-time communication testing

API TestingHTTP ClientBrowserDesktopOpen-SourceGraphQLWebSocket

Restfox Websocket Example is an example object payload from Restfox, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptioncollectionrequestmessages

Example Payload

restfox-websocket-example.json Raw ↑
{
  "description": "Example of a WebSocket connection in Restfox for real-time communication testing",
  "collection": "WebSocket Tests",
  "request": {
    "name": "Real-time Order Updates",
    "type": "websocket",
    "url": "wss://{{wsHost}}/v1/orders/{{orderId}}/stream",
    "headers": [
      {"name": "Authorization", "value": "Bearer {{accessToken}}", "enabled": true}
    ],
    "environment": {
      "wsHost": "ws.example.com",
      "orderId": "order_9876",
      "accessToken": "my-bearer-token"
    }
  },
  "messages": [
    {
      "direction": "sent",
      "payload": "{\"type\": \"subscribe\", \"channel\": \"order-updates\"}"
    },
    {
      "direction": "received",
      "payload": "{\"type\": \"order-update\", \"orderId\": \"order_9876\", \"status\": \"shipped\", \"timestamp\": \"2026-05-02T10:30:00Z\"}"
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/restfox-websocket-example"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

A second provider on the same verified email joins the account you already have.