Publish Live Status
live_statusStart, update, or end a live progress card on the room members' lock screen (an iOS Live Activity / Android live update). Reuse the same correlation_id for every ping of one stream: the first ping starts the card and sends one alert, further "running" pings move it silently, and the first "done"/"failed" sends one completion alert and ends it. Free accounts get a small number of NEW streams per day; updates and the final ping are never charged.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | No | Arbitrary structured context (max 25 keys / 8KB), returned on read surfaces after connector privacy filtering. Do not put secrets in data. | |
| title | No | Card title. Defaults to the selected quick action's label. | |
| action | No | Quick-action slot to attribute the stream to (supplies the icon and sound). | |
| invite_code | Yes | Room invite code. | |
| live_status | Yes | The live card's state. Only state is required. | |
| requires_ack | No | Add an Acknowledge button; the first eligible member to tap resolves it for everyone. Does not raise the interruption level — set category "alert" for a time-sensitive start. | |
| correlation_id | Yes | The stream key. Reuse it on every ping of the same stream. | |
| ack_timeout_seconds | No | Optional acknowledgement deadline in seconds. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes | Purpose-built PingRoom result with credential and account fields removed. |