Trigger WebSocket

Ejecute un workflow a partir de mensajes enviados por una conexión WebSocket y retransmita mensajes entre los peers conectados.

Descripción general

Un trigger WebSocket proporciona al workflow un endpoint en tiempo real. Los navegadores se conectan a él con ?room=ID, y cada mensaje se retransmite a los demás peers de esa sala. La retransmisión se realiza en el runtime y no consume ejecuciones del workflow. Active Run the flow on every message cuando el workflow también deba procesar cada mensaje, por ejemplo para guardar mensajes de chat o responder con un modelo de IA mediante un nodo Realtime Send.

Endpoint

Campo	Descripción	Predeterminado
`Path`	La ruta del endpoint, por ejemplo `realtime/chat`	-

Autenticación

Campo	Descripción	Predeterminado
`Require Authentication`	Validar un JWT durante el handshake de la conexión	Activado
`Token Source`	`Subprotocol`, `Query param` o `First message`. Subprotocol envía `['ubex.jwt', '<token>']` como protocolos WebSocket y es la opción recomendada, porque las query strings acaban en los registros de acceso	Subprotocol
`JWT Secret`	Un secreto del Vault	-
`Algorithm`	`HS256`, `HS384` o `HS512`	HS256

Salas y difusión

Campo	Descripción	Predeterminado
`Broadcast Mode`	`All peers (including sender)`, `Other peers (exclude sender)` o `Targeted (flow decides)`	Other peers
`Who can join a room`	`Any room`, o `Match pattern` para restringir las salas. Con Any room, cualquier conexión autenticada puede unirse a cualquier sala, incluida una que pertenezca a otra persona	Any room
`Max Peers Per Room`	Conexiones por sala	50
`Max Concurrent Rooms`	Salas abiertas al mismo tiempo	100

Presencia

Campo	Descripción	Predeterminado
`Emit Presence Events`	Avisar a la sala cuando un peer se une o se va	Activado
`Identity Claim`	Claim del JWT que se usa como `sender_id`	`email`

Invocación del flujo

Campo	Descripción	Predeterminado
`Run the flow on every message`	Déjelo desactivado para solo retransmitir mensajes en el runtime, sin consumir ejecuciones del workflow	Desactivado

Avanzado

Campo	Descripción	Predeterminado
`Sender Identity`	`Server (from the token)` o `Client (trust the payload)`. La identidad de servidor sobrescribe cualquier campo de remitente del payload, de modo que un peer no puede hacerse pasar por otra persona	Server
`Max Payload Size`	Bytes por mensaje	65536
`Rate Limit`	Mensajes por segundo, por conexión	30
`Ping Interval`	Segundos	30
`Pong Timeout`	Segundos antes de considerar que el peer se ha desconectado	10
`Idle Timeout`	Segundos. Ping y pong cuentan como actividad	86400
`CORS Origins`	Lista opcional de orígenes permitidos	-

Buenas prácticas

Mantenga Require Authentication activado y use Match pattern para que los usuarios solo puedan unirse a sus propias salas.
Deje Run the flow on every message desactivado para retransmisiones de chat simples; actívelo solo cuando cada mensaje necesite procesarse.

Actualizamos estas páginas a menudo. ¿Has visto algo desactualizado? Avísanos