> ## Documentation Index > Fetch the complete documentation index at: https://docs.protodesk.io/llms.txt > Use this file to discover all available pages before exploring further. # Stream workspace events (SSE) > A Server-Sent Events stream of the workspace event outbox — the same events and payloads delivered to webhooks. Each message carries the event id in the SSE `id:` field; reconnect with `Last-Event-ID` (or the `cursor` query param) to replay events missed while disconnected. Without a cursor, only events created after the connection opens are sent. A `: heartbeat` comment is sent during idle periods, and the server closes long-lived connections (~15m) with a `: reconnect` comment so clients resume with a fresh cursor. ## OpenAPI ````yaml GET /realtime/events openapi: 3.1.0 info: title: Protodesk API version: 0.1.0 description: > The Protodesk Platform API: sync your customers in, attach your own business objects (orders, bookings, listings) to conversations, post and read messages across channels, and receive every workspace event via signed webhooks or a resumable SSE stream. Authenticate every request with a workspace-scoped API key: `Authorization: Bearer pk_live_...`. Create endpoints accept an `Idempotency-Key` header so retries are always safe. Lists use opaque cursor pagination (`data` / `hasMore` / `nextCursor`). Task-oriented guides: [docs.protodesk.io](https://docs.protodesk.io). servers: - url: https://api.protodesk.io/v1 description: Production - url: http://localhost:8080/v1 description: Local development security: [] tags: - name: Customers description: People or companies contacting a workspace across channels. - name: Conversations description: Customer conversations attached to channels and external business objects. - name: Messages description: Customer, agent, AI, system, and internal messages inside conversations. - name: Channel identities description: >- The same customer across WhatsApp, email, chat, and more — linked identities per channel. - name: Statuses & priorities description: The workspace's conversation statuses and priority levels. - name: Assignments description: >- Who a conversation has been assigned to, over time. Assign via POST /conversations/{conversationId}/assign. - name: Webhooks description: Webhook subscriptions for receiving workspace events. - name: Realtime description: Server-sent event stream of workspace events. - name: API Keys description: Create, list, and revoke workspace API keys. - name: Account description: The workspace and scopes behind your API key. - name: System description: Service metadata and health endpoints. paths: /realtime/events: get: tags: - Realtime summary: Stream workspace events (SSE) description: > A Server-Sent Events stream of the workspace event outbox — the same events and payloads delivered to webhooks. Each message carries the event id in the SSE `id:` field; reconnect with `Last-Event-ID` (or the `cursor` query param) to replay events missed while disconnected. Without a cursor, only events created after the connection opens are sent. A `: heartbeat` comment is sent during idle periods, and the server closes long-lived connections (~15m) with a `: reconnect` comment so clients resume with a fresh cursor. operationId: streamEvents parameters: - name: cursor in: query required: false description: >- Event id to resume after. Overridden by the Last-Event-ID header if both are absent here. schema: type: string - name: conversationId in: query required: false description: Only stream events for this conversation. schema: type: string - name: eventTypes in: query required: false description: Comma-separated event types to include (defaults to all). schema: type: string example: message.created,conversation.updated - name: Last-Event-ID in: header required: false description: >- Standard SSE reconnect header; the last event id the client received. schema: type: string responses: '200': description: An event stream. headers: X-Request-Id: $ref: '#/components/headers/RequestId' content: text/event-stream: schema: type: string example: > id: evt_x6q5vl75f5d53m7oet2k4r5w6a event: message.created data: {"id":"evt_...","type":"message.created","apiVersion":"2026-07-09","createdAt":"2026-07-09T12:00:00Z","data":{}} default: $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: headers: RequestId: description: Request id for tracing this request in logs and support. schema: type: string example: req_x6q5vl75f5d53m7oet2k4r5w6a RateLimitLimit: description: >- Request budget for the route class (read or write) applied to this request. schema: type: integer example: 40 RateLimitRemaining: description: Requests remaining in the current budget after this request. schema: type: integer example: 39 RateLimitReset: description: Seconds until the budget refills to its full limit. schema: type: integer example: 1 RetryAfter: description: Seconds to wait before retrying, sent with 429 responses. schema: type: integer example: 1 responses: Error: description: >- Error response. All /v1 responses carry RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset headers. A 429 (rate_limit.exceeded) additionally carries Retry-After. Request bodies exceeding the route-class limit (1KB reads, 64KB writes) return 413 (request.body_too_large). headers: X-Request-Id: $ref: '#/components/headers/RequestId' RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' RateLimit-Reset: $ref: '#/components/headers/RateLimitReset' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' schemas: ErrorEnvelope: type: object required: - error properties: error: $ref: '#/components/schemas/Error' Error: type: object required: - code - message - requestId properties: code: type: string example: route.not_found message: type: string example: Not found requestId: type: string example: req_x6q5vl75f5d53m7oet2k4r5w6a securitySchemes: ApiKeyAuth: type: http scheme: bearer bearerFormat: Protodesk API key description: > Use a workspace API key in the Authorization header. Keys use pk_live__ for production and pk_test__ for test mode. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.