vtex-io-app-settings

To define VTEX IO app settings, create an explicit settingsSchema to model merchant-configurable behavior. This schema separates configuration from code and enforces validation rules, ensuring structured and secure app configuration before runtime consumption.

App settings in VTEX IO separate merchant-configurable values from static code logic. Using a settingsSchema allows you to externalize configuration, enabling dynamic behavior changes without modifying the app's source code or deploying new versions.

Securely consume VTEX IO app settings at runtime by using the getAppSettings function. This approach ensures proper handling of secrets on the backend and applies appropriate default values to prevent runtime errors when configurations are missing.

Yes, VTEX IO app settings can be accessed by both backend and frontend. The skill guides proper consumption patterns, ensuring that sensitive secrets remain securely handled on the backend while allowing frontend access to safe, non-sensitive configuration values.

Use settingsSchema for app-level configuration that dictates merchant-configurable behavior. Content or config data is better suited for entity-specific records, whereas settingsSchema provides explicit validation, defaults, and runtime access for global app behavior.

VTEX IO app settings return undefined when missing configurations lack defaults. Applying appropriate default values within your settingsSchema and validating inputs at consumption ensures stable runtime behavior even if the merchant has not configured specific fields.