Raw schema
{
"type": "object",
"properties": {
"invite_code": {
"type": "string",
"description": "Room invite code."
},
"correlation_id": {
"type": "string",
"maxLength": 255,
"description": "The stream key. Reuse it on every ping of the same stream."
},
"live_status": {
"type": "object",
"description": "The live card's state. Only state is required.",
"properties": {
"state": {
"type": "string",
"enum": [
"running",
"done",
"failed"
],
"description": "running keeps the card live; done/failed end it with one completion alert."
},
"template": {
"type": "string",
"enum": [
"status",
"steps",
"progress",
"metrics",
"countdown",
"question",
"matchup"
],
"description": "Which layout the OS renders. Fixed at stream creation."
},
"category": {
"type": "string",
"enum": [
"status",
"steps",
"alert"
],
"description": "Legacy rendering category; prefer template. \"alert\" has NO template equivalent and is the only way to start a stream time-sensitive (breaks through Focus). Fixed at stream creation."
},
"message": {
"type": "string",
"maxLength": 256,
"description": "The card's live message line."
},
"progress": {
"type": "number",
"minimum": 0,
"maximum": 1,
"description": "Progress bar / Dynamic Island gauge, 0..1."
},
"steps": {
"type": "array",
"items": {
"type": "string",
"maxLength": 40
},
"minItems": 2,
"maxItems": 8,
"description": "Step labels. Required on the first ping of a steps stream; immutable afterwards."
},
"current_step": {
"type": "integer",
"minimum": 0,
"maximum": 8,
"description": "Index into steps; the only mutable steps field."
},
"metrics": {
"type": "array",
"maxItems": 3,
"items": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 24
},
"value": {
"type": "string",
"maxLength": 24
}
},
"required": [
"label",
"value"
],
"additionalProperties": false
},
"description": "Up to 3 {label,value} counters for the metrics template."
},
"deadline_at": {
"type": "integer",
"description": "Epoch seconds the countdown template counts down to."
},
"eta_at": {
"type": "integer",
"description": "Epoch seconds; renders a live ETA on status/progress."
},
"prompt": {
"type": "string",
"maxLength": 256,
"description": "The ask, for the question template."
},
"options": {
"type": "array",
"maxItems": 4,
"items": {
"type": "object",
"properties": {
"value": {
"type": "string",
"maxLength": 64
},
"label": {
"type": "string",
"maxLength": 40
}
},
"required": [
"value",
"label"
],
"additionalProperties": false
},
"description": "Up to 4 {value,label} choices for the question template."
},
"left": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 24
},
"value": {
"type": "string",
"maxLength": 24
}
},
"required": [
"label",
"value"
],
"additionalProperties": false,
"description": "Left side {label,value} for the matchup template."
},
"right": {
"type": "object",
"properties": {
"label": {
"type": "string",
"maxLength": 24
},
"value": {
"type": "string",
"maxLength": 24
}
},
"required": [
"label",
"value"
],
"additionalProperties": false,
"description": "Right side {label,value} for the matchup template."
},
"center": {
"type": "string",
"maxLength": 40,
"description": "Center score/clock for the matchup template."
},
"accent_override": {
"type": "string",
"description": "Hex #rrggbb; a semantic accent for one frame (e.g. deadline red)."
}
},
"required": [
"state"
],
"additionalProperties": false
},
"title": {
"type": "string",
"maxLength": 40,
"description": "Card title. Defaults to the selected quick action's label."
},
"action": {
"type": "integer",
"minimum": 1,
"maximum": 4,
"description": "Quick-action slot to attribute the stream to (supplies the icon and sound)."
},
"data": {
"type": "object",
"description": "Arbitrary structured context (max 25 keys / 8KB), returned on read surfaces after connector privacy filtering. Do not put secrets in data."
},
"requires_ack": {
"type": "boolean",
"description": "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."
},
"ack_timeout_seconds": {
"type": "integer",
"minimum": 1,
"maximum": 86400,
"description": "Optional acknowledgement deadline in seconds."
}
},
"required": [
"invite_code",
"correlation_id",
"live_status"
],
"additionalProperties": false
}