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

Path parameters

topicIdstringRequired

Topic Id to publish event data too

Example: quoteStream

Responses

200

OK

application/json

eventTypestringOptional

eventTimeinteger · int64Required

ingestTimeinteger · int64Required

valueobjectOptional

uUIDstringOptional

subTypeobjectOptional

get

/joule/ws/stream/{topicId}

HTTPcURLJavaScriptPython

GET /joule/ws/stream/{topicId} HTTP/1.1
Accept: */*

200

OK

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