.. _Alerting:

Quality Alerting
================

Scout can automatically send alerts when a stream's quality drops below a configurable VMAF
threshold. This feature requires an **Enterprise** license.

Configuration
-------------

.. code-block:: yaml

   alertingEnabled: true
   alertingWebhookUrl: "https://your-endpoint/alerts"
   vmafThreshold: 70   # fires when effective VMAF drops below this value

Alert evaluation runs every 15 seconds across all active streams.

Webhook payload
---------------

When a stream's effective VMAF falls below ``vmafThreshold``, Scout sends an HTTP POST to
``alertingWebhookUrl`` with ``Content-Type: application/json``:

.. code-block:: json

   {
     "stream": "myStream",
     "vmaf": 62.4,
     "threshold": 70
   }

The alert fires every evaluation cycle for as long as the stream's VMAF remains below the
threshold — there is no separate "clear" notification.

Score sources
^^^^^^^^^^^^^

Alert evaluation uses the same merged score pool as the :ref:`Telemetry` endpoint:

- **Injected VMAF** (from ``POST /mqa/{streamName}`` with ``"metric":"vmaf"`` — see
  :ref:`MQA`) takes precedence.
- **Computed VMAF** (on-device libvmaf, requires ``cmsdVmafEnabled=true``) is used as a
  fallback.
- If neither source has a score for a stream in the current cycle, that stream is skipped.