Skip to content

Record real use of the caller's sandbox (a preview interaction)

POST
/api/workspaces/{workspaceId}/apps/{id}/activity
curl --request POST \
--url http://localhost:8080/api/workspaces/example/apps/example/activity \
--cookie auth_session=<auth_session>

The workbench calls this when the person interacts with the live preview (focuses or points into it). It keeps the sandbox from the idle pause; an open tab that only polls never does. Never starts, resumes or touches a sandbox.

workspaceId
required
string
id
required
string

Successful response

Media typeapplication/json
object
success

Whether the request succeeded.

boolean
data

Endpoint-specific response payload.

message
string
error
string

Example

{
"message": "Operation completed",
"error": "Error message"
}

Invalid request

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}

Internal server error

Media typeapplication/json
object
success
boolean
error
string

Example

{
"error": "Error message"
}