A single WebSocket connection carries many logical channels. The client names a channel on each execute request and SignalFlow stamps that name into every response message it emits for that computation.
Must be sent within 5 seconds of establishing the WebSocket connection. May be re-sent with a new token to re-authenticate or switch organization without reconnecting; a valid re-authentication does n
send
sendExecute
Starts a new SignalFlow computation on a named channel. Optional properties include job start time, stop time, resolution, maxDelay, and lists of publish() and detect() labels to disable.
send
sendDetach
send
sendStop
receive
receiveStream
Control, metadata, expired-tsid, data and event messages. Data messages are binary-encoded over WebSocket; every other type is JSON. Over SSE all messages are JSON.
Messages
authenticate
Authenticate request
Content-Type:
execute
Execute request
Content-Type:
detach
Detach request
Content-Type:
stop
Stop request
Content-Type:
control-message
Status and progress of the stream and the job.
Content-Type: application/json
metadata
Metadata for an output time series produced by the computation.
Content-Type: application/json
expired-tsid
Indicates that a specific output time series is no longer part of the computation.
Content-Type: application/json
data
One message per compute iteration per publish() call, carrying the logical timestamp and a list of data points identified by time series ID.
Content-Type: application/json
event
Sent when a detect() block detects or clears an incident.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.