Extension Config


To configure and customize your service plugin, you need to provide important details in the plugin.json configuration file.

Note

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

Configuration Params
dashboardPluginIdstringformat GUID

ID of the dashboard plugin that provides a configuration interface for your sorting method, allowing Wix users to customize algorithm parameters.


deploymentUriSpiBaseUri

Base URI where you deploy your service plugin implementation. Wix appends the method path to this base URI when calling your SortStaffMembers method. For example, if your base URI is https://example-staff-sorter.com/, Wix calls https://example-staff-sorter.com/v1/sort-staff-members.


methodDescriptionstringmaxLength 100

Clear explanation of how your sorting method works and which factors it considers. Explain what business problems it solves and when to use this method. For example, Assigns staff based on current workload, ensuring fair distribution of bookings across your team. Best for businesses prioritizing balanced work schedules.


methodNamestringmaxLength 100

Name for your custom sorting method that's displayed to Wix users in the dashboard when selecting a staff assignment method. Use clear, benefit-focused language. For example, Workload Balancer, Customer Preference Matching, or AI-Powered Optimizer. Avoid technical jargon.

Did this help?