Actions27
- Set Detect
- Set Recordings
- Set Snapshots
- Set Audio Detection
- Set Motion Detection
- Set Improve Contrast
- Set Camera Enabled
- Set Motion Threshold
- Set Motion Contour Area
- Set Birdseye (Camera)
- Set Birdseye Mode
- PTZ Command
- Set PTZ Autotracker
- Set Global Notifications
- Set Per-Camera Notifications
- Suspend Per-Camera Notifications
- Set Audio Transcription
- Set Review Alerts
- Set Review Detections
- Set Object Descriptions
- Set Review Descriptions
- Set Motion Mask
- Set Object Mask
- Set Zone
- Restart
- Publish to Custom Topic
- Wait for Next Topic Value
Set Review Descriptions
AI-generatedSummary
Toggle review descriptions for a camera
Inputs
- camera (required) — The camera name as configured in Frigate
- value (required) — Whether to turn the feature on or off
- awaitState — Whether to keep the socket open after publishing and wait for the matching /state read-back to confirm the new value
- awaitTimeoutMs — How long to wait for the /state read-back before giving up (0-600000 ms)
Output shape
A success payload with operation, topic, payload, and published flag
If awaitState is true, the payload also includes received, confirmed, stateTopic, and stateValue fields; otherwise only the basic fields are returned
Examples
Example 1: Enable review descriptions for the front_door camera
operation=setReviewDescriptions; camera=front_door; value=ON
Example 2: Disable review descriptions for rear_camera with state confirmation
operation=setReviewDescriptions; camera=rear_camera; value=OFF; awaitState=true
Example 3: Enable review descriptions for side_door and wait for confirmation with 10000ms timeout
operation=setReviewDescriptions; camera=side_door; value=ON; awaitState=true; awaitTimeoutMs=10000