Stream Kit DocsAPI ReferenceOverlay
Send to Overlay
Overlay handler: overlay:overlay:send-to-overlay
Send to Overlay
| Handler ID | overlay:overlay:send-to-overlay |
| Plugin | Overlay |
| Category | Overlay |
Variables
Copy variables into handler fields using {variableName} syntax.
{overlayId}{event}{payload}{timestamp}| Name | Type | Description |
|---|---|---|
{overlayId} | string | ID of the overlay that received the event. |
{event} | string | Event name sent to the overlay (for example alert or clear). |
{payload} | object | Data object delivered to the overlay. Omit the handler payload to forward trigger context. |
{timestamp} | string | ISO timestamp when the overlay event was sent. |
Configuration
| Field | Type | Required | Description |
|---|---|---|---|
| Overlay | select | Yes | Select an overlay |
| Event | combobox | Yes | message |
| Payload | one-of | No | {"username":"{username}","message":"{message}"} |