> For a complete index of all SignalWire documentation pages, fetch https://signalwire.com/docs/llms.txt

# Stream status callback

POST 

Sent to your `status_url` when a background audio stream started with
`calling.stream` changes state. `params.state` is `streaming` when the stream
starts and `finished` when it ends.

Reference: https://signalwire.com/docs/apis/rest/calls/webhooks/stream-status-callback

## OpenAPI 3.1 Webhook Specification

```yaml
openapi: 3.1.0
info:
  title: signalwire-rest
  version: 1.0.0
paths: {}
webhooks:
  stream-status-callback:
    post:
      operationId: stream-status-callback
      summary: Stream status callback
      description: >-
        Sent to your `status_url` when a background audio stream started with

        `calling.stream` changes state. `params.state` is `streaming` when the
        stream

        starts and `finished` when it ends.
      responses:
        '200':
          description: Webhook received successfully
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                event_type:
                  $ref: >-
                    #/components/schemas/WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaEventType
                  description: >-
                    The type of event. Always `calling.call.stream` for stream
                    status callbacks.
                event_channel:
                  type: string
                  description: The channel the event was delivered on.
                timestamp:
                  type: number
                  format: double
                  description: When the event was sent, as a Unix timestamp in seconds.
                project_id:
                  type: string
                  format: uuid
                  description: Your project ID.
                space_id:
                  type: string
                  format: uuid
                  description: Your Space ID.
                params:
                  $ref: >-
                    #/components/schemas/WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaParams
                  description: Details about the stream.
              required:
                - event_type
                - event_channel
                - timestamp
                - project_id
                - space_id
                - params
components:
  schemas:
    WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaEventType:
      type: string
      enum:
        - calling.call.stream
      description: >-
        The type of event. Always `calling.call.stream` for stream status
        callbacks.
      title: WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaEventType
    WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaParamsState:
      type: string
      enum:
        - streaming
        - finished
      description: >-
        The stream state. `streaming` when the stream starts, `finished` when it
        ends.
      title: >-
        WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaParamsState
    WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaParams:
      type: object
      properties:
        call_id:
          type: string
          format: uuid
          description: ID of the call being streamed.
        node_id:
          type: string
          format: uuid
          description: ID of the node the call is on.
        segment_id:
          type: string
          format: uuid
          description: ID of the call segment being streamed.
        tag:
          type: string
          description: >-
            The tag associated with the call. Present only when a tag was set on
            the call.
        control_id:
          type: string
          description: >-
            The control ID used to control the stream, as set in
            `calling.stream`.
        state:
          $ref: >-
            #/components/schemas/WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaParamsState
          description: >-
            The stream state. `streaming` when the stream starts, `finished`
            when it ends.
        url:
          type: string
          description: The WebSocket URL the audio is being streamed to.
        name:
          type: string
          description: >-
            The friendly name of the stream. Present when a `name` was set on
            the stream.
      required:
        - call_id
        - node_id
        - segment_id
        - control_id
        - state
        - url
      description: Details about the stream.
      title: WebhooksStreamStatusCallbackPayloadContentApplicationJsonSchemaParams

```