Documentation Menu

Server-Sent Events

SSE event stream

GET /workspaces/{wid}/events

Requires authentication.

Open a Server-Sent Events stream for real-time updates in a workspace. Events include new messages, reactions, typing indicators, presence changes, and channel updates. Supports reconnection with Last-Event-ID header to catch up on missed events.

Parameters

Name In Type Description
wid path string Workspace ID

Responses

  • 200 SSE event stream — text/event-stream

Start typing indicator

POST /workspaces/{wid}/typing/start

Requires authentication.

Broadcast a typing indicator to other members of a channel. The indicator automatically expires after a few seconds if not refreshed.

Parameters

Name In Type Description
wid path string Workspace ID

Request body 

{
  "channel_id": "01JQ3KMQ8YNBC3DFHM6RWVS7AG"
}

Responses

200 Typing started

{
  "success": true
}

Stop typing indicator

POST /workspaces/{wid}/typing/stop

Requires authentication.

Clear the typing indicator for a channel. Called when the user stops typing or sends their message.

Parameters

Name In Type Description
wid path string Workspace ID

Request body 

{
  "channel_id": "01JQ3KMQ8YNBC3DFHM6RWVS7AG"
}

Responses

200 Typing stopped

{
  "success": true
}