Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Websocket",
"description": "Placeholder websocket action contract.",
"type": "object",
"examples": [
{
"title": "Subscribe to a stream",
"description": "Opens a websocket, stores incoming messages under Context.<Key>. Bind a Text or List to that key to render live updates. The playground surfaces connect/disconnect events in the Actions log.",
"document": {
"PresentationType": "Column",
"Children": [
{
"PresentationType": "Button",
"Text": "Subscribe to echo",
"BorderRadius": 6,
"Color": "#FFFFFF",
"BackgroundColor": "#2F6FED",
"OnClick": {
"Handler": "Websocket",
"Url": "wss://echo.websocket.org",
"Key": "_stream"
}
},
{
"PresentationType": "SizedBox",
"Height": 12
},
{
"PresentationType": "Text",
"Text": "Latest: {{ Context._stream }}",
"Color": "#5A6473"
}
]
}
}
],
"x-version": "1.0",
"required": [
"Handler"
],
"properties": {
"Handler": {
"const": "Websocket"
},
"OnSuccess": {
"$ref": "/schema/Actions/Action/1.0/index.json"
},
"OnFailure": {
"$ref": "/schema/Actions/Action/1.0/index.json"
}
},
"additionalProperties": false,
"x-icon": "<svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\" fill=\"none\" stroke=\"currentColor\" stroke-width=\"1.7\" stroke-linecap=\"round\" stroke-linejoin=\"round\"><path d=\"M3 12h4l2-4 3 8 2-4h7\"/></svg>",
"$id": "/schema/Actions/Websocket/1.0/index.json",
"x-family": "Actions",
"x-name": "Websocket",
"x-source-package": "zero-schema"
}
Opens a websocket, stores incoming messages under Context.<Key>. Bind a Text or List to that key to render live updates. The playground surfaces connect/disconnect events in the Actions log.
{
"PresentationType": "Column",
"Children": [
{
"PresentationType": "Button",
"Text": "Subscribe to echo",
"BorderRadius": 6,
"Color": "#FFFFFF",
"BackgroundColor": "#2F6FED",
"OnClick": {
"Handler": "Websocket",
"Url": "wss://echo.websocket.org",
"Key": "_stream"
}
},
{
"PresentationType": "SizedBox",
"Height": 12
},
{
"PresentationType": "Text",
"Text": "Latest: {{ Context._stream }}",
"Color": "#5A6473"
}
]
}