Official Apps Tools
Tools for installing, updating, and removing the apps Serenities ships.
Available Tools
workspaceApp_listThe apps Serenities ships (for example Social: a calendar and composer for the account's social channels) with this account's install state: installed or not, the install id to open it at /dashboard/apps/i/<installId>/open, the version it runs, whether a newer release exists, and legacyProjectId when an older copy install has not yet moved onto a release.
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "workspaceApp_list",
"arguments": {}
}
}workspaceApp_getInstallOne install of this account's (params: installId): its app, name, version and whether it is ready to open.
Input Schema
installId | stringrequired |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "workspaceApp_getInstall",
"arguments": {
"installId": "example"
}
}
}workspaceApp_usageHow many workspace apps this workspace has and how many its plan allows: { used, limit } (limit is null when the plan has no limit). Apps built here and apps installed from the app store count together. Check it before creating or enabling an app.
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "workspaceApp_usage",
"arguments": {}
}
}workspaceApp_installEnable an official app for this account (params: key, e.g. "social"). One release of the app is built once and shared by everyone who has it; enabling creates a row and a base of the account's own — no copy, no build. Re-running moves an existing install to the newest release and is never refused. A NEW install is a workspace app and counts against the plan's limit on workspace apps: when the workspace is full the call is refused with a plain message and an upgrade link — tell the person that message and give them the link, never retry.
Input Schema
key | stringrequired | App key from list, e.g. "social" |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "workspaceApp_install",
"arguments": {
"key": "example"
}
}
}workspaceApp_uninstallRemove an official app from this account (params: key). Deletes the install row; the account's base, social channels and posts are kept, and nothing of the vendor's is touched.
Input Schema
key | stringrequired | App key from list, e.g. "social" |
Example Call
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "workspaceApp_uninstall",
"arguments": {
"key": "example"
}
}
}