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

# Mux Plugin

> Mux video hosting for Streamly — access tokens, webhooks, signed playback, and Catalog Playback IDs.

**Mux API** (`video.mux`) is a Streamly **plugin** in the **video** category.

**Mux API** connects Streamly to the vendor video platform and unlocks the matching catalog source.

## Learn the service

Watch this overview of the vendor platform (helpful before you paste keys into Streamly).

<Frame caption="Mux Video API Quick Start — Mux.">
  <iframe src="https://www.youtube.com/embed/HFYfI_ZC3EQ" title="Mux Video API Quick Start" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowFullScreen />
</Frame>

## At a glance

| | |
| - | - |
| **Plugin ID** | `video.mux` |
| **Category** | video |
| **Version** | 1.0.0 |
| **Unlocks addon** | [`Mux`](/addons/mux) (`addon.mux`) |
| **Webhook** | `POST /api/webhooks/mux` |
| **Ingest** | Upload at **vendor** — Streamly has no vendor upload UI |
| **Paste on title** | Playback ID |

## Capabilities

* `video.live`
* `video.ingest`
* `video.delivery`
* `video.analytics`

## When to use it

* Production VOD hosted on Mux API
* Attach Playback ID under Catalog → Sources after upload

## How it works

### Playback flow

| Step | Where | What you do |
| - | - | - |
| **1** | Vendor dashboard | Upload / encode the video |
| **2** | Vendor UI | Copy Playback ID / UID / GUID / video id |
| **3** | `/admin/plugins` | Enable & configure the video plugin |
| **4** | Catalog → Sources | Attach the ID on the title |
| **5** | Storefront | Viewer plays via the managed adapter |

## Official vendor documentation

* [API basic auth](https://www.mux.com/docs/guides/make-api-requests#http-basic-auth)
* [Play your videos](https://www.mux.com/docs/guides/play-your-videos)
* [Webhooks](https://www.mux.com/docs/core/listen-for-webhooks)
* [Secure playback](https://www.mux.com/docs/guides/secure-video-playback)

## Smoke test without Mux

Use [Demo HLS](/addons/demo-hls) for a public test stream with the native player.

## FAQ

<AccordionGroup>
  <Accordion title="I don’t see this in Addons Discover">
    Correct — video-plugin-owned sources are hidden. Enable this plugin instead.
  </Accordion>

  <Accordion title="Webhook fired but no title appeared">
    Expected — paste the ID on the title yourself.
  </Accordion>
</AccordionGroup>

## Related

* [Mux Addon](/addons/mux)
* [Catalog](/admin-dashboard/catalog)
* [Addons Overview](/addons/overview)
* [Plugins Overview](/plugins/overview)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.