Skip to main content

Connect to Salesforce

Learn how to connect Salesforce to Retool.

You can connect to Salesforce and make it available as a resource in Retool. Once complete, your users can write queries that interact with Salesforce data.

Requirements and settings

The following requirements for a Salesforce resource depend on whether you are creating a resource on a cloud-hosted Retool organization or a self-hosted deployment.

Requirements for cloud-hosted Retool

The following requirements must be met to successfully create Salesforce resources.

RequirementDescription
Sufficient user permissions to create resources

All users for Retool organizations on Free or Team plans have global Edit permissions and can add, edit, and remove resources. If your organization manages user permissions for resources, you must be a member of a group with Edit all permissions.

Resource configuration settings

You must be able to provide the settings needed to create a resource. This may require you to perform actions, such as generating access credentials or creating a client application.

Resource authentication settings

You must have access to the data source and sufficient permissions to perform the actions needed, and be able to provide valid authentication settings.

Allow Retool access to the data source

If the data source is behind a firewall or restricts access based on IP address then you must ensure that your Retool organization can access it. If necessary, configure your data source to allow access from Retool's IP addresses.

Configuration settings for cloud-hosted Retool

Cloud-hosted Retool organizations support the following configuration settings.

SettingDescription
API Version

The API version to use.

Connect to a sandbox organization

Whether to connect to a sandbox Salesforce organization.

Customize Salesforce OAuth URLs

Whether to specify your own URLs for authentication.

Cloud-hosted Retool organizations can also optionally configure the following advanced options.

SettingDescription
Override default outbound Retool region

Specify a different outbound region from which Retool connects. This can improve performance if your resource is located in a different region to us-west-2.

Use custom connected app

Whether to use a custom OAuth app.

Authentication settings for cloud-hosted Retool

Cloud-hosted Retool organizations can authenticate with this resource using the following methods. You must be able to provide the necessary credentials for the method you wish to use.

Connect with OAuth 2.0

Authentication is performed using Oauth 2.0 with the data source provider. You and your users can authenticate directly with the integration. Some integrations allow sharing credentials during resource creation.

SettingDescription
Share credentials between users

Whether the authenticated credentials should be shared across all users. If enabled, all users share the same credentials and do not need to complete authentication themselves. All queries from Retool are made on behalf of the same authenticated user.

Connect with OAuth

Click to authenticate.

1. Create a resource

Sign in to your Retool organization and navigate to the Resources tab. Click Create new > Resource, then select Salesforce.

2. Configure the resource

Specify a name and location for your Salesforce resource. Retool displays the resource name and type in query editors to help users identify them. Next, provide the required information to create the resource. Depending on how your data source is configured, you may also need to provide optional settings for Retool to connect.

Custom connected apps

note

On self-hosted Retool deployments, Salesforce resources require Retool to be a connected app. On Retool Cloud, select Use custom connected app to use a connected app.

  1. Create a connected app in Salesforce.
  2. After you select Enable OAuth Settings, enter the OAuth callback URL from Retool's resource settings.
  3. In Selected OAuth Scopes, enter the following scopes:
  • Full access (full)
  • Manage user data via APIs (api)
  • Perform requests at any time (refresh_token, offline_access)

These scopes refer to permissions given by the user running the connected app.

  1. Save the app to create the Consumer Key and Secret. Add these to the Salesforce consumer key and Salesforce consumer secret in Retool.
  2. Enter your Salesforce URL in the Salesforce instance URL field in Retool. This URL must end in .salesforce.com, so if your URL ends in .lightning.force.com, you must update it to use .my.salesforce.com.

3. Save the resource

Click Create resource to complete the setup. You can then click either Create app to immediately start building a Retool app or Back to resources to return to the list of resources.

Wrap up

Your Salesforce resource is now ready to use. To start querying Salesforce data:

  1. Add a Resource query to an app or a Resource query block to a workflow.
  2. Select the new Salesforce resource from the resources dropdown.
  3. Write and run a query.