For the complete documentation index, see llms.txt. This page is also available as Markdown.

Salesforce API Access Requirements

A number of Wave Embedded features rely on Salesforce REST API calls to function. This page lists those features, explains what each one needs API access for, and walks through the setup required so they work correctly in your org.

Prerequisite

Features That Require API Access

The following features rely on Salesforce REST API calls and are used during configuration by Designers and Admins.

Designer and Admin Features

These features run when a Designer or Admin is configuring Wave, such as building a grid or setting up actions.

Feature
Why API Access Is Required

Grid Wizard — Salesforce List Views

When an object is selected in the Grid Wizard, Wave fetches the details of the selected Salesforce List View to help set up the grid.

Wave retrieves lookup filter metadata through a REST API call.

Actions Configuration Screen — LWC Component List

Wave retrieves the list of available LWC components to display on the Row Action and Grid Action configuration screens.

Configured Location

Wave fetches and displays the configured location through a REST API call.

Requirements

For all of the features above to work correctly, both of the following must be in place.

API Enabled Permission

The user must have the API Enabled permission in Salesforce. This is controlled at the Profile or Permission Set level.

To check or enable it as an Admin:

  1. In Salesforce, go to Setup.

  2. Under Administration, click Users, then open Profiles (or Permission Sets, if assigned that way).

  3. Select the profile or permission set used by the affected users.

  4. Under System Permissions, find API Enabled.

  5. Click Edit, check the API Enabled box, and click Save.

IP Restrictions, If Applicable

If the org has IP restrictions enabled, the Salesforce IP ranges applicable to the user's region must be added to the allow list. If this step is skipped, REST API calls will fail even when the user has API access.

To check whether your org restricts IPs:

  1. In Salesforce, go to Setup.

  2. Search for Network Access under Security.

  3. If any ranges are listed under Trusted IP Ranges, your org is restricting access to those IPs only, and Salesforce's own IP ranges need to be added here as well.

  4. Separately, check the affected user's Profile for a Login IP Ranges section. If ranges are listed there, the same addition needs to happen at the profile level.

To add the required Salesforce IP ranges:

  1. Identify your Salesforce org instance (for example, NA1, EU2, AP1), found under Company Information.

  2. Look up that instance's region using status.salesforce.com.

  3. Get the matching IP ranges from either of the sources below.

  4. Add those ranges to Network Access (org-wide) or the relevant Profile's Login IP Ranges (profile-level), depending on where the restriction is set.

Salesforce IP ranges can be found here:

Once both requirements are met, all of the features listed above will function as expected.

Identifying the Correct IP Ranges to Whitelist

Use the steps below to find the right Salesforce IP ranges for your org.

  1. Identify the Salesforce org instance (for example, NA1, EU2, AP1). This is found in Company Information.

  2. Determine the region for that instance using status.salesforce.com.

  3. Find the corresponding IP ranges using either the IP Ranges JSON or the Salesforce Help article linked above.

Salesforce Region to IP Registry Mapping

Salesforce IP ranges are published by regional internet registries. Use this mapping to narrow down which ranges apply to your org.

Registry
Region Covered

ARIN

North America — United States, Canada, and parts of the Caribbean

LACNIC

Latin America and the Caribbean — Brazil, Argentina, Mexico, and others

RIPE

Europe, the Middle East, and parts of Central Asia

APNIC

Asia-Pacific — India, Australia, Japan, Singapore, and others

Last updated

Was this helpful?