Configure Permissions for Your App

This article explains how to identify the required permissions and add them to your app configuration. For more information, see About Permissions.

Important: When your app authenticates on behalf of a Wix user, it takes into account the roles specific to that user, which can influence the permissions granted to your app. Learn more about user roles.

Step 1 | Identify required permissions

To identify which permissions your app requires:

  1. Go to the REST API, JavaScript SDK, or Velo (for Wix Blocks) reference.

  2. Search for the endpoints or methods your app uses.

  3. Find the supported permission scopes under Permission Scopes:

  4. Select one of the permission scopes listed to include in your app. You can click on a scope to prompt the addition to your app, as described in the next section.

Warning: Only request the permissions your app requires. Apps that request unnecessary permissions aren’t allowed on the app market.

Step 2 | Add permissions to your app

To add permissions to your app:

  1. Go to Permissions in your app's dashboard.

  2. Click Add Permissions.

  3. Search or filter for the relevant scope.

  4. Select the relevant scopes from the results.

    Tip: Keep in mind that some high-level permission scopes, like Read Stores - All Read Permissions, encompass multiple other permission scopes, such as Read Products and Read Orders. Therefore, you don’t need to add the lower scopes separately.

  5. Click Save.

When a site owner installs your app, they’re prompted to approve the specified permissions.

Was this helpful?
Yes
No