> ## Documentation Index
> Fetch the complete documentation index at: https://docs.insforge.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard event stream

> Long-lived Server-Sent Events stream carrying dashboard cache-invalidation
and MCP connection notifications. Emits a `ready` event on connect, then
`data-update` and `mcp-connected` events as `data:` frames, with `: keepalive`
comment heartbeats every 25 seconds.

Requires admin credentials (project admin JWT or API key); anon keys and
authenticated end-user JWTs are rejected. Proxies must pass
`text/event-stream` through unbuffered and allow long-lived connections.




## OpenAPI

````yaml https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/dashboard.yaml get /api/dashboard/events
openapi: 3.0.3
info:
  title: Insforge Dashboard API
  version: 1.0.0
  description: >-
    Dashboard-internal control-plane endpoints. Not part of the
    application-facing SDK contract.
servers: []
security: []
paths:
  /api/dashboard/events:
    get:
      tags:
        - Dashboard
      summary: Dashboard event stream
      description: >
        Long-lived Server-Sent Events stream carrying dashboard
        cache-invalidation

        and MCP connection notifications. Emits a `ready` event on connect, then

        `data-update` and `mcp-connected` events as `data:` frames, with `:
        keepalive`

        comment heartbeats every 25 seconds.


        Requires admin credentials (project admin JWT or API key); anon keys and

        authenticated end-user JWTs are rejected. Proxies must pass

        `text/event-stream` through unbuffered and allow long-lived connections.
      responses:
        '200':
          description: SSE stream of dashboard events
          content:
            text/event-stream:
              schema:
                type: string
                description: >
                  Each frame is `data: <json>\n\n`, where the JSON is one of:

                  - `{"type":"ready"}`

                  -
                  `{"type":"data-update","resource":"database|users|buckets|functions|deployments|compute_services","data":{...}}`
                  (`data` is optional)

                  - `{"type":"mcp-connected","toolName":"...","createdAt":"<ISO
                  8601>"}`
                example: |
                  data: {"type":"ready"}

                  data: {"type":"data-update","resource":"users"}
        '401':
          description: Missing or invalid credential
        '403':
          description: Valid JWT without the project_admin role
      security:
        - bearerAuth: []
        - apiKey: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Project admin JWT or an API key passed as a Bearer token.
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````