Subscribe to workspace realtime events (SSE)

GET

/api/workspaces/{workspaceId}/realtime

const url = 'http://localhost:8080/api/workspaces/example/realtime';
const options = {method: 'GET', headers: {cookie: 'auth_session=<auth_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/workspaces/example/realtime \
  --cookie auth_session=<auth_session>

Server-Sent Events stream of workspace realtime events. Session auth only (EventSource cannot send API-key headers).

Authorizations

cookieAuth

Parameters

Path Parameters

workspaceId

required

string

Query Parameters

clientId

string

Responses

200

SSE event stream.

text/event-stream

string

4XX

Invalid request

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}

5XX

Internal server error

application/json

object

success

boolean

error

string

Example

{
  "error": "Error message"
}