For Dashboard Designers Reference ServerSentEvents
Friday, August 8, 2025 7:56 AMServerSentEvents
Label: :IA_Function
Property: type: ServerSentEvents
Inherits from: Function
The ServerSentEvents Function is listening to a stream of data from a given server. This Function can listen on a WebSocket or HTTP connection.
ServerSentEvents is using the EventSource browser API for HTTP connections and WebSocket API for WebSocket connections.
Parameters
Key | Description | Default value | Possible values |
---|---|---|---|
url |
server address to listen | '' | string |
withCredentials |
property is a boolean value that indicates whether or not cross-site Access-Control requests should be made using credentials. | true | boolean |
Outgoing triggers
Type: messageReceived
Occurrence: when data was sent succesfully
Key | Description | Possible values |
---|---|---|
data |
Data sent by the server | string / object |
Example configuration
(:IA_Function{
"type": "ServerSentEvents",
"url": "https://graphileon.com/sse.php"
}) - [:TRIGGER{
"type": "messageReceived",
"#_update.add.data": "evaluate(fromJSON((%).data))"
}] -> (:IA_Function{
"type": "TableView",
"$options.pagination": "true",
"$options.paginationAutoPageSize": "true",
"_instance": "sseaggridview"
})