Custom Embed Object


A custom embed is an entity that manages custom HTML and JavaScript code embedded in a site, along with its placement and properties.

Properties
domainstringformat HOSTNAME

Site domain that's connected to the site, if relevant.


embedDataCustomEmbed

Custom embed data.


enabledboolean

Whether the custom embed is enabled on the site. Default: true.


idstringRead-onlyformat GUID

Custom embed ID.


loadOnceboolean

Whether to load the custom embed once during initial site rendering, rather than on each page navigation. This setting affects performance and should be chosen based on the embed's functionality. Default: true.


namestringminLength 1maxLength 100

Custom embed name, as displayed to Wix users.


positionstring

Position where the custom embed code is placed on the page.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the custom embed is updated. To prevent conflicting changes, the current revision must be passed when updating a custom embed.

Did this help?