Add App Permissions in Blocks

When an app is installed on a Wix site, the app may need to access and manage some of the site's data. To enable this, the site builder must grant the required permission scopes to the app when installing it. The app permissions are specific to the APIs that you use in your app.

Code that requires permissions

Adding permissions is required in the following cases:

• If you added dependencies to Wix apps: If you added dependencies to Wix's business-solutions apps (such as Stores or Bookings), you are probably using their APIs. You must add permissions, or else these APIs will cause your code to fail.
• If you need to access site data: If your app needs to access data from sites it's installed on, you'll need permissions to use the specific APIs required for this data.
• If you used other APIs: Even if you didn't add permissions and don't need to access site data, there are other Velo APIs that require permissions.

You do not need permissions in the following cases:

• For your app's internal business logic.
• For your custom panel code, including the wix-widget and wix-editor modules.
• To use wix-dashboard module.

When permissions are missing

If your app requires permissions, but you haven't added them, site builders won't be able to provide consent, causing your code to fail.

While everything might seem fine in Blocks (the release process won't fail), once the app is installed on a site, the site will show an error and the console will say that an API failed.

Finding the required permissions

Follow these steps to make sure you have added the required permissions. Each step is only needed if the previous one wasn't successful.

1. Check the Velo reference: In most cases, if an API requires permissions, you will see it in the Velo reference, under the Permissions section.

   For example, the bulkCreateBooking() function requires the following permissions:

   • MANAGE BOOKINGS
   • MANAGE BOOKINGS - ALL PERMISSIONS

   You can click the permission to add it to your app.

   

2. Check the legacy list: If no permissions are specified in the API reference, check if it's included in the Velo legacy APIs permissions list.

3. No permissions needed: Only if the API you are using has no permissions specified in the Velo reference and doesn't appear in the legacy list, you can assume that no permissions are needed.

Ways to add permissions

You can add permissions in several ways:

• In Blocks, click WixBlocks > App > App Permissions. This takes you to your app dashboard Permissions section.
• Go directly to your app Permissions section in the app dashboard.
• Click a specific permission from the Velo API reference and then select your app.

See also

• About Permissions in Wix Apps
• Velo API Reference
• Legacy Velo API Permissions