> This page is for APIs.

> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes.

# room.started

GET /

Receive room.started events

Reference: https://signalwire.com/docs/apis/relay/client/fabric/room-started

## AsyncAPI Specification

```yaml
asyncapi: 2.6.0
info:
  title: room.started
  version: subpackage_roomStarted.room.started
  description: Receive room.started events
channels:
  /:
    description: Receive room.started events
    publish:
      operationId: subpackage_roomStarted.room.started-publish
      summary: room.started
      message:
        name: onRoomStartedRoomStartedEvent
        title: room.started
        payload:
          $ref: '#/components/schemas/room.started_roomStartedEvent'
servers:
  production:
    url: wss://relay.signalwire.com/
    protocol: wss
    x-default: true
components:
  schemas:
    ChannelsRoomStartedMessagesRoomStartedEventJsonrpc:
      type: string
      enum:
        - '2.0'
      description: JSON-RPC version. Always `2.0`.
      title: ChannelsRoomStartedMessagesRoomStartedEventJsonrpc
    ChannelsRoomStartedMessagesRoomStartedEventMethod:
      type: string
      enum:
        - signalwire.event
      description: Always `signalwire.event`.
      title: ChannelsRoomStartedMessagesRoomStartedEventMethod
    ChannelsRoomStartedMessagesRoomStartedEventParamsEventType:
      type: string
      enum:
        - room.started
      description: The event type — identifies which event this is.
      title: ChannelsRoomStartedMessagesRoomStartedEventParamsEventType
    Fabric.Member:
      type: object
      properties:
        id:
          type: string
          description: The member ID.
        room_id:
          type: string
          description: The room this member belongs to.
        room_session_id:
          type: string
          description: The room session this member belongs to.
        name:
          type: string
          description: Friendly display name.
        type:
          type: string
          description: The member type, such as `member` or `screen`.
        call_id:
          type: string
          description: >-
            The member's call ID. Present on join events and where the member is
            addressed directly.
        parent_id:
          type: string
          description: >-
            Associated parent member, for a screenshare or an additional-device
            member.
        audio_muted:
          type: boolean
          description: Whether the member's audio is muted.
        video_muted:
          type: boolean
          description: Whether the member's video is muted.
        handraised:
          type: boolean
          description: Whether the member has their hand raised.
        visible:
          type: boolean
          description: Whether the member is visible in the layout.
        deaf:
          type: boolean
          description: Whether the member is deafened (not hearing the conference audio).
        input_volume:
          type: number
          format: double
          description: >-
            Input (microphone) volume, in decibels, from -50 to 50. May be
            fractional.
        output_volume:
          type: number
          format: double
          description: >-
            Output (speaker) volume, in decibels, from -50 to 50. May be
            fractional.
        input_sensitivity:
          type: number
          format: double
          description: Input (microphone) sensitivity, from 0.0 to 100.0.
        requested_position:
          type: string
          description: The member's last-requested layout position.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: Customer-provided metadata for the member.
        node_id:
          type: string
          description: >-
            The node the member's call leg lives on. Present on most member
            events.
        updated:
          type: array
          items:
            type: string
          description: The fields that changed — present on the `member.updated` event.
      required:
        - id
        - room_id
        - room_session_id
        - name
        - type
        - audio_muted
        - video_muted
        - handraised
        - visible
        - deaf
        - input_volume
        - output_volume
        - input_sensitivity
        - requested_position
        - meta
      description: >-
        A member of a Call Fabric conference — one participant's state. Carried
        on the

        `member.updated`, `member.joined`, and `member.left` events and returned
        by

        `call.member.list` in a conference. Fields match the Video API's
        `Member`.


        On a 1:1 (non-conference) call, member data uses the `CallMember` shape
        instead,

        keyed by `member_id` rather than `id`.
      title: Fabric.Member
    Fabric.RoomSession:
      type: object
      properties:
        id:
          type: string
          description: The room session ID.
        project_id:
          type: string
          description: Your project ID.
        room_id:
          type: string
          description: The room ID.
        event_channel:
          type: string
          description: The event channel this room session publishes on.
        name:
          type: string
          description: The room's name.
        display_name:
          type: string
          description: The room's display name.
        layout_name:
          type: string
          description: The name of the layout currently applied.
        locked:
          type: boolean
          description: Whether the room is locked to new participants.
        recording:
          type: boolean
          description: Whether the room is currently being recorded.
        streaming:
          type: boolean
          description: Whether the room is currently being streamed.
        hide_video_muted:
          type: boolean
          description: Whether video-muted members are hidden from the layout.
        prioritize_handraise:
          type: boolean
          description: Whether raised hands are prioritized in the layout.
        audience_count:
          type: integer
          description: Number of audience (receive-only) participants.
        preview_url:
          type: string
          description: A preview image URL for the room, when available.
        meta:
          type: object
          additionalProperties:
            description: Any type
          description: Customer-provided metadata for the room.
        members:
          type: array
          items:
            $ref: '#/components/schemas/Fabric.Member'
          description: >-
            The members currently in the room session. An empty array when the
            member list is not included.
        recordings:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: The room's recordings. Included when requested.
        streams:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: The room's streams. Included when requested.
        playbacks:
          type: array
          items:
            type: object
            additionalProperties:
              description: Any type
          description: The room's playbacks. Included when requested.
        updated:
          type: array
          items:
            type: string
          description: The fields that changed — present on the `room.updated` event.
      required:
        - id
        - project_id
        - room_id
        - event_channel
        - name
        - display_name
        - layout_name
        - locked
        - recording
        - streaming
        - hide_video_muted
        - prioritize_handraise
        - audience_count
        - meta
        - members
      description: >-
        The full state of a Call Fabric room session — the shared conference a
        set of members

        are in. Delivered on `room.updated`. Fields match the Video API's Room
        Session.
      title: Fabric.RoomSession
    Fabric.RoomStartedParams:
      type: object
      properties:
        room_id:
          type: string
          description: The room ID.
        room_session_id:
          type: string
          description: The room session ID.
        room_session:
          $ref: '#/components/schemas/Fabric.RoomSession'
          description: The room session that started, with its full state.
        room:
          type: object
          additionalProperties:
            description: Any type
          description: >-
            Deprecated. A legacy copy of `room_session` that carries
            `room_session_id` in place of `id`. Use `room_session` instead.
      required:
        - room_id
        - room_session_id
        - room_session
      description: 'Payload of the `room.started` event: the room session that just started.'
      title: Fabric.RoomStartedParams
    ChannelsRoomStartedMessagesRoomStartedEventParams:
      type: object
      properties:
        event_type:
          $ref: >-
            #/components/schemas/ChannelsRoomStartedMessagesRoomStartedEventParamsEventType
          description: The event type — identifies which event this is.
        event_channel:
          type: string
          description: >-
            The channel the event was delivered on — for Calling events, the
            `protocol`

            string your connection received from `signalwire.connect`.
        timestamp:
          type: number
          format: double
          description: >-
            When the event was emitted, as a Unix timestamp in seconds. Always
            present.
        project_id:
          type: string
          description: >-
            Your project ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        space_id:
          type: string
          description: >-
            Your space ID. Present on Calling events and most Call Fabric
            events; absent on `call.joined`, `call.left`, `member.joined`, and
            `member.left`.
        params:
          $ref: '#/components/schemas/Fabric.RoomStartedParams'
          description: The event-specific payload.
      required:
        - event_type
        - event_channel
        - timestamp
        - params
      description: The event envelope.
      title: ChannelsRoomStartedMessagesRoomStartedEventParams
    room.started_roomStartedEvent:
      type: object
      properties:
        jsonrpc:
          $ref: >-
            #/components/schemas/ChannelsRoomStartedMessagesRoomStartedEventJsonrpc
          description: JSON-RPC version. Always `2.0`.
        id:
          type: string
          description: >-
            Event id — a unique UUID generated for each event. Events are
            notifications: you do not reply to them.
        method:
          $ref: >-
            #/components/schemas/ChannelsRoomStartedMessagesRoomStartedEventMethod
          description: Always `signalwire.event`.
        params:
          $ref: >-
            #/components/schemas/ChannelsRoomStartedMessagesRoomStartedEventParams
          description: The event envelope.
      required:
        - jsonrpc
        - id
        - method
        - params
      description: >-
        Fires when a Call Fabric room session starts. Delivers the room
        session's initial state.
      title: room.started_roomStartedEvent

```