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 Description
guid required string
"example-string"
Blueprint action GUID to share event for
Key Type Example Description
authorization required string
"Bearer access_token"
Access 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 }
{ "error": "INVALID_ACCESS_TOKEN", "code": 401 }
Status Error Code Description
401 INVALID_ACCESS_TOKEN Authentication required or invalid token
Permission Description
Bearer token Access token required via Authorization header, x-authtoken, x-token, query param, or cookie
blueprintactions_view Required scope: blueprintactions_view

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