← All resources

Resource

custom_app

A custom app with embedded Vue components

GraphQL reference →

Configuration

nameString!Required

Human-readable name (required)

handleString!Required

URL-safe slug (required, unique within tenant)

forces replacement

iconString!Optional

Icon identifier (optional)

kindCustomAppKind!Required

App kind (required)

Allowed values

PAGE — Appears as a page in the sidebar navigation

DASHBOARD — Appears as a tab on the dashboard

KIOSK — App intended for a dedicated terminal

JOB_VIEW — Embedded view for job details

dataContainerSpecStringOptional

Optional JSON schema for custom data container validation

publishedVersionIdCustomAppVersionIDOptional

TypeID 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.

References custom_app_version

written by `publishCustomApp`, not by this resource's update

Read-only values

Show values
idCustomAppID!Read only

Unique identifier

computed by the platform

templateString!Read only

Vue template HTML to render in the iframe

computed by the platform

scriptString!Read only

JavaScript/TypeScript script to execute client-side

computed by the platform

serverApiStringRead only

Optional Lua script for server-side RPC handlers

computed by the platform

hasServerApiBoolean!Read only

Whether this app has a server-side API script configured

computed by the platform

publishedVersionIntRead only

The version number published to end users (nil = draft only)

computed by the platform

useDaisyUIBoolean!Read only

Include bundled DaisyUI styles with host theme colours. Optional for engine 3; legacy engines always include their existing styles.

computed by the platform

engineVersionInt!Read only

Custom-app engine version: 1 = legacy, 2 = split Vue + Lua exports, 3 = App.vue SFC + Lua exports. New apps default to 3.

computed by the platform

createdAtString!Read only

Creation timestamp (ISO8601)

computed by the platform

updatedAtString!Read only

Last update timestamp (ISO8601)

computed by the platform

Lifecycle

The CLI can create this resource. The platform assigns its id.

When replacement is needed, the existing resource is removed before its replacement is created.