Within your app project, the source code for service plugins is found in the src/backend/service-plugins
folder.
Each page is defined in its own subfolder that contains two files:
plugin.ts
- Contains functions that override the functions called by Wix for the plugin.plugin.json
- Provides all required configuration for your plugin.This file is required and contains handler functions that Wix calls automatically when the relevant site action triggers them.
The file contains:
For example, the plugin.ts
for the shipping rates plugin looks like this:
1
Your custom logic should be placed inside the {}
for each of these functions. To find out what your function receives in the parameters and what it must return, see the documentation. Locate your service plugin in this table and click on the link to view its documentation, then navigate to the specific function in the menu.
This file is required and provides all the necessary configuration for your plugin.
The file contains an object with each of the required fields you can use to customize your plugin. You will need to add any optional configuration fields yourself.
You can find the details for each of these fields by locating your service plugin in this table and clicking on the link to view its documentation.
Note: Your plugin.json
file does not require a deployment URI as the CLI knows where to call your app's endpoint.