iframe Query Parameters for Extensions

Widget extension

Name	Value	Comments
endpoint	The Widget URL as supplied during the app registration in your app's dashboard
compId	The ID of the Widget extension	While the instanceId remain constant within the scope of the site, each iframe will have a unique and persistent compId
viewMode	Current view mode	"editor" or "site". "editor" is valid inside the Wix editor, while "site" is available only in a published website
deviceType	Current device type	"desktop" or "mobile"
locale	Current locale value
originCompId	ID of the original widget that the user copied (or cut)	When a user copies (or cuts) a widget, this query parameter appears in the pasted widget. Use it to retrieve the original widget’s design, layout, and other settings
width	The width of the iframe in pixels
instance	The signed instance	The App Instance ID (instanceId) is the unique identifier of your app within a specific user's website.

Widget app settings panel

Name	Value	Comments
endpoint	The App Settings URL as supplied during the app registration in your app's dashboard
compId	The compId value for the app settings is always tpaSettings
instance	The signed instance	The App Instance ID (instanceId) is the unique identifier of your app within a specific user's website.
locale	Current locale value
originCompId	The ID of the extension which associated with the App Settings	The origCompId identifies the current extension that the user is editing
width	The width of the iframe in pixels

Page extension

Name	Value	Comments
endpoint	The Widget URL as supplied during the app registration in your app's dashboard
viewMode	Current view mode	"editor" or "site". "editor" is valid inside the Wix editor, while "site" is available only in a published website
deviceType	Current device type	"desktop" or "mobile"
locale	Current locale value	This is the browser's language identified with two characters. E.g., English = en
width	The width of the iframe in pixels	The frame height will auto-adjust depending on the frame content
```instance``	The signed instance	The App Instance ID (instanceId) is the unique identifier of your app within a specific user's website.
target	Attribute that must be added to all href anchors within the Page iframe
sectionUrl	The base URL of the page extension
app-state	The inner state of the page extension	The app-state part of the URL may include a query string, but must not include a #
compId	The ID of the extension	While the instanceId remain constant within the scope of the site, each iframe will have a unique and persistent compId

Page app settings panel

Name	Value	Comments
endpoint	The App Settings URL as supplied during the app registration in your app's dashboard
compId	The compId value for the app settings is always tpaSettings
instance	The signed instance	The App Instance ID (instanceId) is the unique identifier of your app within a specific user's website.
locale	Current locale value	This is the browser's language identified with two characters. E.g., English = en
origCompId	The ID of the extension which associated with the App Settings	The origCompId identifies the current extension that the user is editing
width	The width of the iframe in pixels

Worker extension

Name	Value	Comments
compId	The ID of the Worker extension	While the instanceId remain constant within the scope of the site, each iframe will have a unique and persistent compId
viewMode	Current view mode	"editor" or "site". "editor" is valid inside the Wix editor, while "site" is available only in a published website
deviceType	Current device type	"desktop" or "mobile"
locale	Current locale value
endpointType	The Worker URL as supplied during the app registration in your app's dashboard
instance	The signed instance	The App Instance ID (instanceId) is the unique identifier of your app within a specific user's website.