openapi: 3.2.0
info:
  title: Zoca Platform Socket Debug API
  description: 'The Zoca platform API behind the Zoca web app and mobile apps: scheduling, website generation, Google Business Profile, discovery/local SEO, social media, booking enquiries, offers, clients, staff, billing and the Zoca "brain" agent layer.'
  version: 3.20.10
  contact: {}
  x-apievangelist-note: Harvested verbatim from https://api.zoca.ai/swagger.json. The provider ships the default NestJS Swagger metadata (title "API Documentation", empty servers[]); title/description/servers were set by API Evangelist for identification and the unmodified original is preserved at openapi/_original/zoca-platform-swagger.json. Every path, operation, summary, parameter and response is exactly as published.
servers:
- url: https://api.zoca.ai
  description: Production
tags:
- name: Socket Debug
paths:
  /socket-debug/test-client:
    get:
      description: Serves an interactive HTML page for testing Socket.IO connections and rooms
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: HTML test client page
          content:
            text/html: {}
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get HTML test client
      tags:
      - Socket Debug
  /socket-debug/rooms:
    get:
      description: Returns all active rooms with their member counts and socket IDs
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: List of all rooms with details
          content:
            application/json:
              schema:
                example:
                  totalRooms: 3
                  totalConnections: 10
                  rooms:
                    entity-123:
                      size: 3
                      sockets:
                      - socket-id-1
                      - socket-id-2
                      - socket-id-3
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get all Socket.IO rooms
      tags:
      - Socket Debug
  /socket-debug/rooms/{roomId}/members:
    get:
      description: Returns all socket IDs connected to a specific room
      operationId: t_value
      parameters:
      - name: roomId
        required: true
        in: path
        description: The room ID to inspect
        schema:
          example: entity-123
      responses:
        '200':
          description: List of socket IDs in the room
          content:
            application/json:
              schema:
                example:
                  roomId: entity-123
                  members:
                  - socket-id-1
                  - socket-id-2
                  memberCount: 2
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get room members
      tags:
      - Socket Debug
  /socket-debug/rooms/{roomId}/broadcast:
    post:
      description: Broadcasts a custom event with data to all clients in a specific room using POST with JSON body
      operationId: t_value
      parameters:
      - name: roomId
        required: true
        in: path
        description: The room ID to broadcast to
        schema:
          example: entity-123
      requestBody:
        required: true
        description: Event name and data to broadcast
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e'
            examples:
              Simple Message:
                value:
                  event: test-message
                  data:
                    message: Hello, World!
              Homepage Data:
                value:
                  event: homepage-data
                  data:
                    unmarkedLeadsCount: 5
                    unreadUpdatesCount: 3
      responses:
        '200':
          description: Broadcast successful
          content:
            application/json:
              schema:
                example:
                  success: true
                  roomId: entity-123
                  event: test-message
                  memberCount: 3
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Broadcast message to room (POST)
      tags:
      - Socket Debug
  /socket-debug/broadcast:
    get:
      description: Quick broadcast endpoint using query parameters instead of JSON body
      operationId: t_value
      parameters:
      - name: event
        required: false
        in: query
        description: Event name (defaults to test-message)
        schema:
          example: custom-event
      - name: message
        required: true
        in: query
        description: The message text to send
        schema:
          example: Hello, World!
      - name: roomId
        required: true
        in: query
        description: The room ID to broadcast to
        schema:
          example: entity-123
      responses:
        '200':
          description: Broadcast successful
          content:
            application/json:
              schema:
                example:
                  success: true
                  roomId: entity-123
                  event: test-message
                  message: Hello, World!
                  memberCount: 3
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Broadcast message to room (GET)
      tags:
      - Socket Debug
  /socket-debug/health:
    get:
      description: Returns health information including active connections and total rooms
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Health status information
          content:
            application/json:
              schema:
                example:
                  status: ok
                  activeConnections: 10
                  totalRooms: 5
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get Socket.IO health status
      tags:
      - Socket Debug
  /socket-debug/backdoor/messages:
    get:
      description: Returns all messages received by a specific backdoor connection
      operationId: t_value
      parameters:
      - name: connectionKey
        required: true
        in: query
        description: The backdoor connection key
        schema:
          example: debug-connection-123
      responses:
        '200':
          description: List of messages received
          content:
            application/json:
              schema:
                example:
                  connectionKey: debug-connection-123
                  messages:
                  - event: homepage-data
                    data:
                    - unmarkedLeadsCount: 5
                    timestamp: '2025-01-15T10:30:00.000Z'
                  messageCount: 1
                  timestamp: '2025-01-15T10:32:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get backdoor connection messages
      tags:
      - Socket Debug
  /socket-debug/backdoor/clear:
    post:
      description: Clears all stored messages for a specific backdoor connection
      operationId: t_value
      parameters:
      - name: connectionKey
        required: true
        in: query
        description: The backdoor connection key
        schema:
          example: debug-connection-123
      responses:
        '200':
          description: Messages cleared successfully
          content:
            application/json:
              schema:
                example:
                  success: true
                  connectionKey: debug-connection-123
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Clear backdoor connection messages
      tags:
      - Socket Debug
  /socket-debug/backdoor/connections:
    get:
      description: Returns a list of all active backdoor connection keys
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: List of active backdoor connections
          content:
            application/json:
              schema:
                example:
                  connections:
                  - debug-connection-1
                  - debug-connection-2
                  connectionCount: 2
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get all active backdoor connections
      tags:
      - Socket Debug
  /socket-debug/instance-info:
    get:
      description: Returns instance metadata (ECS task ID, hostname, process ID, uptime) for debugging cross-instance Socket.IO communication
      operationId: t_value
      parameters: []
      responses:
        '200':
          description: Instance information
          content:
            application/json:
              schema:
                example:
                  instanceId: i-0123456789abcdef
                  taskId: arn:aws:ecs:ap-south-1:123456789:task/abc123
                  hostname: ip-10-0-1-100.ap-south-1.compute.internal
                  processId: 1234
                  uptime: 3600
                  timestamp: '2025-01-15T10:30:00.000Z'
        '401':
          description: Unauthorized - Invalid or missing JWT token or API key
      security:
      - x-api-key: []
      - bearer: []
      summary: Get instance/server information
      tags:
      - Socket Debug
components:
  schemas:
    e:
      type: object
      properties:
        id:
          type: number
        entityId:
          type: string
        attribute:
          type: string
        value:
          type:
          - object
          - 'null'
        metadata:
          type:
          - object
          - 'null'
        createdAt:
          type:
          - object
          - 'null'
      required:
      - id
      - entityId
      - attribute
  securitySchemes:
    access-token:
      scheme: bearer
      bearerFormat: JWT
      type: http
      name: Authorization
      description: Enter JWT token in the format Bearer <token>
      in: header