protect_subscribe_events
Collect real-time UniFi Protect events by listening to the WebSocket for up to 30 seconds, returning motion, ring, smart detection, sensor alerts, and metadata like license plates or NFC IDs.
Instructions
Connect to the Protect event WebSocket and collect messages for a specified duration (1-30s). Returns {messages, duration, error?}; each event message includes: id, type ('motion' | 'ring' | 'smartDetectZone' | 'smartDetectLine' | 'sensorMotion' | 'sensorAlarm' | 'fingerprint' | 'nfcCard' | ...), start, end (null while ongoing), camera/sensor id, score, smartDetectTypes (['person','vehicle','animal','package','license_plate','face']), metadata (e.g. detected license plate text, NFC card id, fingerprint id, ULP user match).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| duration | No | Seconds to listen (1-30, default 5) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | Connection error, if any | |
| duration | No | Actual listen duration in seconds (number) | |
| messages | No | Captured WebSocket messages (add/update/remove or event envelopes) |