Client SDK overview

The Webstorio client SDK is available on every published site and in the builder preview as window.webstorio. Use it in page code to load CMS content, submit forms, manage carts, and handle visitor sign-in.

Runtime

// "public" on live sites; "preview" in the builder
window.webstorio.env;

// "published" | "preview" | "local" | "dummy" | "empty"
window.webstorio.dataMode;

`dataMode`	When
`published`	Live site — real data from your project
`preview`	Builder preview — draft or preview data
`local`	CLI preview using project fixtures (JSON/CSV)
`dummy`	Template preview with sample data
`empty`	Blank page scaffold

Feature-gated methods

Methods only work when the matching website feature is enabled:

Feature	SDK area
Content & CMS	Content methods
Form & Survey	Form methods
Online Store	Store & cart methods
User Authentication	Auth & My orders
App Data	Custom table CRUD

Check what’s active:

const { features } = await window.webstorio.getFeatures();

Method index

General

Method	Description
`getFeatures()`	Enabled website features
`getPathParams()`	Dynamic route params from slug wildcards
`getImageUrl(url, opts?)`	Image URL helper with placeholder fallback

Content

getContentTypes, getContentEntries, getContentEntryById, getContentCategories, getContentCategoryById→ Content SDK

Forms

getFormSchema, getForm, submitForm, getFormSubmissions, getFormSubmissionById→ Forms SDK

App Data

getDataModels, listRecords, getRecord, createRecord, updateRecord, deleteRecord→ App Data SDK

Store

Catalog: getStore, getProducts, getProductById, getProductBySlug, getProductCategoriesCart: getCart, addToCart, setCartItems, setCartItemQuantity, removeFromCart, clearCartOrders: createOrder, getMyOrders, getMyOrderById→ Store SDK

Auth

signInWithWebstorio, signOut, getSession, getCurrentUser, getAuthConfig→ Auth SDK

Dynamic routes

Pages with wildcard slugs like blog/{content_entry_id} expose params synchronously:

const params = window.webstorio.getPathParams();
// { content_entry_id: "my-post-a1b2c3d4-e5f6-4789-a012-3456789abcde" }

CMS detail URLs use slug + hyphen + entry UUID format.

Sessions and permissions

Reads — usually public; no sign-in required.
Writes — forms, orders, and App Data may require credentials: "include" and/or a signed-in visitor.
App Data — each table’s access preset (public read, signed-in write, etc.) applies.

Calling a method

Every method is available on the global window.webstorio object and returns a promise:

const { entries } = await window.webstorio.getContentEntries("blog_post", {
  status: "published",
  limit: 12,
});

For task-based, in-context examples (listing a blog, wiring a form, building a cart), see the how-to guides. For per-method details, use the feature reference pages above.

Overview

CLI

Client SDK

MCP Server

Help

Client SDK overview

Runtime

Feature-gated methods

Method index

Dynamic routes

Sessions and permissions

Calling a method

​Runtime

​Feature-gated methods

​Method index

​Dynamic routes

​Sessions and permissions

​Calling a method

Runtime

Feature-gated methods

Method index

Dynamic routes

Sessions and permissions

Calling a method