Skip to main content

Assets

What are Assets?

Assets are reusable HTML blocks stored in the Visual Experience Engine. Each asset has a name, slug, and HTML body (code). They are used in scheduled content, linked from pages, and can be targeted by device, location, or category.


Core Properties

PropertyDescription
idUnique identifier
nameDisplay name
slugURL-friendly identifier (lowercase, hyphens; e.g. faq-content)
codeHTML body
statusdraft or published
devicesTarget devices: iphone, ipad, android, web
locationOptional location targeting
categoryOptional category targeting
categoryLocationOptional array of URLs for category/location rules
externalWhether the asset is external (URL-based)
urlExternal URL (when external is true)
scheduleOptional scheduling: startDate, endDate, persistent
createdAt / updatedAtTimestamps

How Assets Are Edited

The Assets form provides two editors for the HTML body:

  1. Text Editor – Rich (WYSIWYG) editor
  2. HTML Editor – Raw HTML code editor (mode: html)

The Asset Name field auto-generates a slug (lowercase, spaces → hyphens).


Where Assets Are Used

ContextUsage
PagesA page can link to an asset via contentId; the app fetches and renders the HTML when the page is opened
Remote APIPublished assets are available via remote-content and remote-pages APIs

Targeting and Scheduling

  • Devices – Assets can be restricted to specific devices (iphone, ipad, android, web).
  • Location – Optional location string for geo or context targeting.
  • Category – Optional category for catalog/merchandising targeting.
  • SchedulestartDate, endDate, and persistent: true meaning no end date.

External Assets

When external is true, the asset points to an external URL instead of storing HTML. The url field must be a valid URI. This is used when the actual asset lives elsewhere (e.g. third-party page).


API: Fetching Assets

Assets are fetched by:

  • Page APIremote-pages returns pages; a page can include linked asset (id, name, slug, code, status).
  • Content APIremote-content can return assets by slug or ID (when available).

Assets are returned only when published and (if scheduled) within their schedule window.


Pages vs. Assets

ConceptPurpose
AssetsReusable HTML blocks
PagesRoutes with slugs that optionally link to an asset

A page provides the route (e.g. about-us); the asset provides the HTML to display when that page is opened.


Key Takeaway

Assets in the BILDIT Visual Experience Engine are reusable HTML blocks managed in the Assets section. Each has a name, slug, HTML body, targeting (devices, location, category), and scheduling. They are used by pages, scheduled content, and the remote APIs.