RUAL Documentation

POST /blueprintactions/realtime/{guid}

Share realtime collaboration events for a specific blueprint action to all connected users

Share realtime collaboration events for a specific blueprint action to all connected users
Key Type Example
:guid required string
"example-guid"
Key Type Example
authorization required string
"Bearer your-jwt-token"
Key Type Example Description
event required string
"cursor-move"
Type of realtime event
message required object
{ "x": 150, "y": 300, "cursor_type": "pointer" }
Event message payload
{ "shared": true }
{ "success": false, "error": "HTTP_401", "message": "Error response" }
Error Code Description
HTTP_401 HTTP 401 error
permission description
BearerAuth JWT access token obtained from login endpoint required

Back to Blueprint Actions Return to the Blueprint Actions category to view other endpoints All API Categories Browse all available API categories