Developer Preview
This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Adds a site plugin to a slot within an app created by Wix.
Note: To use this function, Your app must have a site plugin extension. Learn more about site plugins.
1
Name | Type | Description |
---|---|---|
pluginId | string | ID of the site plugin, which you can find in your app's site plugin extension in the Wix Dev Center. |
options | addSitePluginOptions | Options to use when adding a site plugin. |
1
Name | Type | Description |
---|---|---|
placement | PluginPlacement | Information about the slot in which you want to add the plugin. Learn more about the slots that are available on Wix app pages. |
1
Name | Type | Description |
---|---|---|
appDefinitionId | string | ID of the Wix app. |
widgetId | string | ID of the host widget. |
slotId | string | ID of the slot. |
1
The addSitePlugin()
function can reject with the following errors:
Code | Message |
---|---|
3001 | Slot occupied |
3002 | Slot not found |
3003 | Error adding plugin |
3004 | Error replacing existing plugin |
3005 | Error loading modal data |
3006 | Aborted by user |
3007 | Site not published yet |
To set up a dashboard client, refer to the setup guide.
1