WebSocket

Subscribe to events from a WebSocket

Overview

The Websocket API allows developers to subscribe to processed events from a Joule process. This is useful for validating processing streams.

---

Connect and receive websocket events

get

/joule/ws/stream/{topicId}

Path parameters

topicIdstringrequired

Topic Id to publish event data too

Example: quoteStream

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/joule/ws/stream/{topicId}'

200

200

{
  "eventType": "text",
  "eventTime": 1,
  "ingestTime": 1,
  "value": {},
  "uUID": "text",
  "subType": {},
  "snapshot": {
    "": {},
    "present": true,
    "empty": true
  },
  "lineage": {
    "ANY_ADDITIONAL_PROPERTY": 1
  },
  "dictionary": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

OK