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

topicId*string

Topic Id to publish event data too

Example: "quoteStream"

Response

200

OK

Body

application/json

eventTypestring

lineageobject

eventTime*integer (int64)

ingestTime*integer (int64)

valueobject

uUIDstring

subTypeobject

dictionaryobject

snapshotOptional (object)

Request

JavaScriptCurlPython

const response = await fetch('/joule/ws/stream/{topicId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "eventType": "text",
  "uUID": "text",
  "snapshot": {
    "present": false,
    "empty": false
  }
}