Extend an Existing Object

Schema plugins are backend extensions. Like other extensions in your app, they are added under the Extensions page in the Wix Dev Center.

To add a schema plugin to an app's API object, do the following:

  1. Open the Dev Center and select the app you want to add a schema plugin for.

  2. Go to the Extensions page, 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.

Note: To test your schema plugin, first get your app approved.

Was this helpful?
Yes
No