Extension Config

The JSON object below defines the configuration for this service plugin extension. How you supply values depends on the framework you’re using:

  • Self-hosted apps: After adding a service plugin extension to your app in the app dashboard, provide configuration details in your extension's page. Learn more about how to add and configure a self-hosted service plugin extension with REST or the SDK.
  • CLI apps: When you add a service plugin extension to your app with the Wix CLI, the required configuration details are populated automatically. You can then customize them in your extension's plugin.json file.
Note

If you created your service plugin extension with the CLI, required fields are automatically populated for you.

Configuration Params
deploymentUristringRequiredminLength 1

Base URI which Wix calls to retrieve the selected items. For example, "deploymentUri": "https://my-items.com".

keystringRequiredminLength 3maxLength 250

A unique identifier for the provider.

searchParamsSearchParams

Supported search parameters.

contentDataContentData

Display data such as provider name and icon.

supportedTagsArray <string>maxItems 50

An array of strings representing the Wix UI pages supported by your SPI implementation. If no tags are listed, Wix assumes that the implementation supports all eligible pages.

itemThumbnailItemThumbnail

Configuration settings for how the thumbnail is displayed.

paginationModestring

Pagination Mode

renderOverridesRenderOverrides

Optional render overrides for the provider.

Did this help?