Skip to content

CustomAppState ​

Type: Object

A custom app with embedded Vue components

Fields ​

NameTypeArgsDescriptionDeprecated
createdAtString!Creation timestamp (ISO8601)
dataContainerSpecStringOptional JSON schema for custom data container validation
engineVersionInt!Custom-app engine version (1 = legacy module-table, 2 = native exports). New apps are created at v2.
handleString!Unique URL-safe slug
hasServerApiBoolean!Whether this app has a server-side API script configured
iconString!Icon identifier (defaults to 'app_badging')
idCustomAppID!Unique identifier
kindCustomAppKind!App kind determining display location
nameString!Human-readable name
publishedVersionIntThe version number published to end users (nil = draft only)
publishedVersionIdCustomAppVersionIDTypeID of the version the app currently serves (prefix cav); null when nothing is published. Same fact as publishedVersion, as a reference — a version number is assigned by the server, so only the id can be pointed at by configuration written before the version exists.
scriptString!JavaScript/TypeScript script to execute client-side
serverApiStringOptional Lua script for server-side RPC handlers
templateString!Vue template HTML to render in the iframe
updatedAtString!Last update timestamp (ISO8601)

Connect machines, automate workflows, and build custom apps for print production.