Frigate icon

Frigate

Control Frigate over its real-time /ws API

Wait for Next Topic Value

AI-generated

Summary

Waits on Frigate’s /ws connection for the next broadcast matching a topic, then returns the received message or indicates that the wait timed out.

Inputs

  • Topic (required) — Bare Frigate topic, without the frigate/ prefix. Use a topic Frigate broadcasts, such as front_door/detect/state or events; /set command topics are not echoed. Matching supports + and # wildcards.
  • Timeout (Ms) — Maximum wait in milliseconds, from 0 to 600000; defaults to 5000. Frigate does not replay current or retained state, so the operation waits for a new broadcast.

Output shape

One item per input item, containing a JSON object with the operation, requested topic, whether a message was received, its payload, matched topic, and raw message.

On timeout, received is false and payload, matchedTopic, and raw are null. If the matching message is binary, the item also includes binary data prepared as snapshot.jpg with MIME type image/jpeg. With Continue On Fail enabled, errors are returned as an item containing an error field.

Links

Discussion