WebSocket-Trigger

Einen Workflow über Nachrichten ausführen, die über eine WebSocket-Verbindung gesendet werden, und Nachrichten zwischen verbundenen Teilnehmern weiterleiten.

Überblick

Ein WebSocket-Trigger gibt dem Workflow einen Echtzeit-Endpunkt. Browser verbinden sich mit ?room=ID, und jede Nachricht wird an die anderen Teilnehmer in diesem Raum weitergeleitet. Die Weiterleitung erfolgt in der Laufzeitumgebung und verbraucht keine Workflow-Läufe. Aktivieren Sie Run the flow on every message (Flow bei jeder Nachricht ausführen), wenn der Workflow zusätzlich jede Nachricht verarbeiten soll, zum Beispiel um Chatnachrichten zu speichern oder über einen Realtime-Send-Knoten mit einem KI-Modell zu antworten.

Endpunkt

Feld	Beschreibung	Standard
`Path`	Der Endpunktpfad, zum Beispiel `realtime/chat`	-

Authentifizierung

Feld	Beschreibung	Standard
`Require Authentication`	Ein JWT während des Verbindungs-Handshakes validieren	Ein
`Token Source`	`Subprotocol`, `Query param` oder `First message`. Subprotocol sendet `['ubex.jwt', '<token>']` als WebSocket-Protokolle und wird empfohlen, da Query-Strings in Zugriffsprotokollen landen	Subprotocol
`JWT Secret`	Ein Secret aus dem Vault	-
`Algorithm`	`HS256`, `HS384` oder `HS512`	HS256

Räume und Broadcast

Feld	Beschreibung	Standard
`Broadcast Mode`	`All peers (including sender)`, `Other peers (exclude sender)` oder `Targeted (flow decides)`	Other peers
`Who can join a room`	`Any room` oder `Match pattern`, um Räume einzuschränken. Bei Any room kann jede authentifizierte Verbindung jedem Raum beitreten, auch einem, der jemand anderem gehört	Any room
`Max Peers Per Room`	Verbindungen pro Raum	50
`Max Concurrent Rooms`	Gleichzeitig geöffnete Räume	100

Präsenz

Feld	Beschreibung	Standard
`Emit Presence Events`	Den Raum informieren, wenn ein Teilnehmer beitritt oder ihn verlässt	Ein
`Identity Claim`	JWT-Claim, der als `sender_id` verwendet wird	`email`

Flow-Ausführung

Feld	Beschreibung	Standard
`Run the flow on every message`	Deaktiviert lassen, um Nachrichten nur in der Laufzeitumgebung weiterzuleiten, ohne Workflow-Läufe zu verbrauchen	Aus

Erweitert

Feld	Beschreibung	Standard
`Sender Identity`	`Server (from the token)` oder `Client (trust the payload)`. Die Server-Identität überschreibt jedes Absenderfeld im Payload, sodass sich ein Teilnehmer nicht als jemand anderes ausgeben kann	Server
`Max Payload Size`	Bytes pro Nachricht	65536
`Rate Limit`	Nachrichten pro Sekunde und Verbindung	30
`Ping Interval`	Sekunden	30
`Pong Timeout`	Sekunden, bis der Teilnehmer als getrennt gilt	10
`Idle Timeout`	Sekunden. Ping und Pong zählen als Aktivität	86400
`CORS Origins`	Optionale Liste erlaubter Origins	-

Best Practices

Lassen Sie Require Authentication aktiviert und verwenden Sie Match pattern, damit Benutzer nur ihren eigenen Räumen beitreten können.
Lassen Sie Run the flow on every message bei reinen Chat-Weiterleitungen deaktiviert; aktivieren Sie es nur, wenn jede Nachricht verarbeitet werden muss.

Wir aktualisieren diese Seiten laufend. Ist etwas nicht mehr aktuell? Sagen Sie es uns