App Data SDK

Setup in the dashboard: App Data guide

App Data exposes custom database tables defined in your project dashboard. Requires the App Data feature (app_data) — Growth plan and above. Access per table is configured in the dashboard (e.g. public read, authenticated write). The SDK respects those presets; unauthorized calls return API errors.

getDataModels()

List tables (models) available to the current visitor.

const models = await window.webstorio.getDataModels();
// [{ key, name, fields, apiAccess, ... }]

Call this first to discover valid modelKey values and field schemas.

listRecords(modelKey, options?)

const result = await window.webstorio.listRecords("directory", {
  limit: 50,
  offset: 0,
  search: "coffee",
  searchField: "name", // optional — field key to search
});

// { records: [{ id, dataJson, ... }], total, limit, offset }

getRecord(modelKey, recordId)

const { content_entry_id } = window.webstorio.getPathParams();
const record = await window.webstorio.getRecord("directory", recordId);

Use on detail pages with dynamic slugs or when you have an ID from a list.

createRecord(modelKey, dataJson)

await window.webstorio.createRecord("waitlist", {
  email: "[email protected]",
  name: "Alex",
});

Typically requires signed-in visitor or public-write preset.

updateRecord(modelKey, recordId, dataJson)

await window.webstorio.updateRecord("inventory", recordId, {
  quantity: 42,
});

deleteRecord(modelKey, recordId)

await window.webstorio.deleteRecord("inventory", recordId);

Schema validation

dataJson must match the table schema defined in the dashboard. Invalid fields or types are rejected with validation errors.

Dashboard configuration

Configure tables under Project → Data (or App Data). Set field types, validation, and API access presets before calling SDK methods from generated pages.

Overview

CLI

Client SDK

MCP Server

Help

getDataModels()

listRecords(modelKey, options?)

getRecord(modelKey, recordId)

createRecord(modelKey, dataJson)

updateRecord(modelKey, recordId, dataJson)

deleteRecord(modelKey, recordId)

Schema validation

Dashboard configuration

​getDataModels()

​listRecords(modelKey, options?)

​getRecord(modelKey, recordId)

​createRecord(modelKey, dataJson)

​updateRecord(modelKey, recordId, dataJson)

​deleteRecord(modelKey, recordId)

​Schema validation

​Dashboard configuration

getDataModels()

listRecords(modelKey, options?)

getRecord(modelKey, recordId)

createRecord(modelKey, dataJson)

updateRecord(modelKey, recordId, dataJson)

deleteRecord(modelKey, recordId)

Schema validation

Dashboard configuration