Stream Kit DocsAPI ReferenceOverlay
Message Received
Overlay trigger: overlay:overlay:message-received
Message Received
| Trigger ID | overlay:overlay:message-received |
| Plugin | Overlay |
| Category | Overlay |
Variables
Copy variables into handler fields using {variableName} syntax.
{overlayId}{event}{payload}{message}{timestamp}| Name | Type | Description |
|---|---|---|
{overlayId} | string | ID of the overlay that received the event. |
{event} | string | Lifecycle or queue event name. |
{payload} | unknown | Extra event payload object (overlay events, Stream Deck settings extras, etc.). |
{message} | string | Full message text from the event. |
{timestamp} | number | ISO timestamp when the event fired. |
Conditions
| Condition | Description |
|---|---|
| Overlay | Filter on Overlay. Configure in the trigger condition editor. |
| Event name | Filter on Event name. Configure in the trigger condition editor. |
| Event | Filter on Event. Configure in the trigger condition editor. |
| JSON field | Match a field inside JSON using a dot-path and text operator. |