Run the Salesforce diagnostic tool
Who can do this: Super Admins, Creators and Integrators
The Salesforce diagnostic tool runs a set of tests against your Salesforce connection, using one Salesforce record you choose. When it finishes, you'll see which tests passed and the error text for any that failed.
This feature is available when it's turned on for your organization. If you don't see it, contact your OnRamp team.
Before you begin
- Connect your Salesforce account under Settings > Integrations+.
- Know which Salesforce record you want to test against, such as an Opportunity. You'll search for it by a text or number field, like its name.
Run the diagnostic tool
- Go to Settings > Integrations+.
- Select the Salesforce integration to open its page.
- At the top of the page, select Run Diagnostics. The Salesforce Diagnostic Tool opens.
- In Object type, choose the Salesforce object to test, such as Opportunity. The list comes from your connected Salesforce org.
- Optional: In Search by Field, choose a different field to search by. It defaults to a name field and lists only text and number fields.
- In Entity, enter at least three characters, then select the record. If you search by an ID field, enter the full, exact ID.
- Select Start. It stays unavailable until you've chosen an object type and a record.
The tests take a while. Keep the dialog open until they finish, or you won't see the results. A message tells you when the run completes. If the run fails or doesn't finish in time, a message says so. Any results that came back still show in the dialog.
Note: Run Diagnostics appears only on the Salesforce integration's page. You won't see it for other integrations or on connection pages inside the integration.
Read the results
Results appear under Results, grouped by category. Each test shows:
- ✅ when it passed.
- ❌ when it failed, with the error text underneath.
Read the error text under each failed test to find the cause. Most of it comes straight from Salesforce, such as INSUFFICIENT_ACCESS or NOT_FOUND. Often, a failure means the Salesforce user you connected with is missing permission to an object, a field, or the record. To fix that, update the integration user's permission set in Salesforce. Our article on configuring Salesforce permissions for OnRamp project automation walks through it.
After you change permissions in Salesforce, run the tool again to confirm the fix.