Extend an Existing Object with a Schema Plugin

Schema plugins are backend extensions that allow you to add fields to an APIs object. Once added with a schema plugin, fields can be read and written using the object's regular endpoints, just like any other field in the object.

To add a schema plugin extension to your app:

1. Select an app from the Custom Apps page in your Wix Studio workspace.

2. Select Extensions in the left side-menu, and click + Create Extension.

   

3. Search for extended fields in the search bar. Choose the object you want to extend and click Create.

4. If this is the first time you're adding a schema plugin to the app, you'll be prompted to create a namespace for the app. This namespace is used when reading and writing any schema plugin fields created for the app. Once you save the namespace, it can't be changed.

   

5. Use the JSON Editor to define your schema plugin as a JSON Schema. The editor's linter indicates if there are any errors in the JSON Schema.

   

6. Once your schema plugin is defined, click Save.

   Important: Once you add a schema plugin to an app, it can't be removed. You can archive the plugin fields to prevent them from being read or written.

Your app now has a schema plugin extension. You can return to the JSON editor to make non-breaking changes to the schema.