← API reference
Mutation / surfaces

invokeWorkspaceAction

Runs a declared Lua action as the caller on the current published Workspace version; returns JSON.

Arguments

Workspace version to inspect or invoke.

handlerString!

Name of the declared server Lua handler.

inputJSONString!

JSON object passed to the handler and validated against its input contract.

Returns String!

Explore in a view

Journeys and Workspaces
View exact SDL
"""
Runs a declared Lua action as the caller on the current published Workspace version; returns JSON.
"""
invokeWorkspaceAction(
  """Workspace version to inspect or invoke."""
  versionId: WorkspaceVersionID!
  """Name of the declared server Lua handler."""
  handler: String!
  """
  JSON object passed to the handler and validated against its input contract.
  """
  inputJSON: String!
): String! @topic(names: ["surfaces"])

Schema reference describes the API contract. Actual access is checked by the platform for every operation.