Articles in this section

Salesforce Integration FAQs

Have questions about Salesforce Integration? We're here to help! Use this guide to find quick answers to common questions and get the most out of your Spekit experience.

πŸ“Œ Quick-Jump Topics

 

1. How the Integration Works

What does Spekit access in my Salesforce org?

Spekit's integration with Salesforce is a one-way, read-only process. It uses Salesforce APIs to pull metadata from your objects, fields, and picklist values. Spekit will never write to or make any changes in your Salesforce environment. View user profile permission requirements.

 

2. Salesforce Connections & Environment

Can I connect my Salesforce Product environment to multiple Spekit accounts?

❌ No. Spekit only supports a 1-to-1 connection. Each Spekit account can connect to only one Salesforce org (Production, Sandbox, or Developer) at a time.

Can I migrate my content from a UAT or Sandbox environment to Production?

βœ… Yes. Content can be migrated between environments by the Spekit team. Note: Analytics and other data cannot be migrated at this time.

Can Admins add themselves as collaborators?

❌ No. Spekit only syncs metadata for objects and fields. Personal data in your Salesforce org is not accessed or stored.

 

3. Field & Spek Management

What information does Spekit import from Salesforce?

Spekit imports the following information about your Salesforce objects, fields, and picklist values:

For Objects

  • Label and SFDC API Name
  • Type (Standard or Custom)
  • Internal Description: imported as the Definition and can be edited in Spekit after the first sync
  • Fields on the object (with total field count)
  • Salesforce Setup Link: directs to that object in Salesforce

For Fields

  • Label and SFDC API Name
  • Help Text: imported as the Definition and can be edited in Spekit after the first sync
  • Field Type: with Calculated Formula if a Formula field, or Related Picklist Values if a Picklist field
  • Required (Y/N) and Default Value
  • Salesforce Setup Link: directs to the "All Fields" view for that object

For Picklist Values

  • Label and Parent Field
⚠️ Note: Spekit does not automatically import picklist values. You must manually import them.

What object types are available on the Manage Objects import screen?

  • Standard Objects: visible by default
  • Custom Objects: visible by default
  • Installed Package Objects: requires a manual sync to see options
  • Salesforce System Objects: requires a manual sync to see options

What happens if a field is renamed in Salesforce?

To sync any changes in Salesforce to Spekit, you must manually perform a sync from your Spekit account. The outcome depends on whether the Field Label or the Field Name was changed:

  • If a Field Label is changed in Salesforce, the Spek's label will be automatically updated after a manual sync.
  • If a Field Name (the API name) is changed in Salesforce, Spekit treats this as a new term. A new Spek will be created after the manual sync is completed.

Does the Spek label need to be an exact match of the field label?

βœ… Yes. For Spekit to accurately match a Spek with its corresponding Salesforce field and display help text, the Spek's label must be an exact match of the field label.

What formatting and media is preserved during import?

βœ… Yes. Any rich text formatting supported in Spekit - including bolding, underlines, and bullet points - will be translated when content is imported.

⚠️ Note on images and files: Images and files hosted on Salesforce will only be embeddable in Spekit if they are publicly accessible. Images and files hosted elsewhere can be embedded without this requirement.

Are system fields like "Last Modified On" imported?

System and frequently occurring fields are auto-hidden to avoid clutter.

  • To view them: Use filters β†’ toggle Show hidden terms β†’ click the "eye" icon to unhide
  • Applies to newly imported objects as of August 15, 2018
  • For older objects: use bulk select β†’ mark as hidden if needed

How do I search for Picklist values in the Chrome Extension?

Once you've imported and documented your Salesforce picklist values in Spekit, you can search for them directly within the Spekit Chrome Extension.

Simply enter the picklist value into the search bar, filter by Speks, click on it, and view its details.

How does the Viewer role differ for field Speks?

The Viewer role has a limited view of a field Spek compared to an Account Admin. Viewers can see the core content of the Spek, including:

  • The field Spek Definition
  • Any custom fields
  • The field's picklist values (if documented)
  • Embedded media like videos, documents, or images

Unlike Account Admins, Viewers cannot see the technical metadata section of the Spek, which includes details like the API Name, Field Type, or other Salesforce-related properties.

 

4. Common Errors & Troubleshooting

I'm seeing an OAuth error, what does this mean?

This error indicates that the Spekit OAuth app has not been installed by a Salesforce administrator for your organization. The OAuth app is required for Spekit to securely connect to your Salesforce instance and is a prerequisite for a successful integration.

Here is a picture of the error message:

screenshot_2025-09-08_at_1.48.08___pm_720.png

What to do:

  • If you are a Salesforce administrator: Please follow the steps in our main article, How to Connect Spekit to Salesforce, specifically the section titled Step 2: Install the Spekit OAuth App in Salesforce.
  • If you are not a Salesforce administrator: Please forward this help center article to your Salesforce admin and ask them to complete the required steps.

Spek icons are not appearing on certain components. What should I do?

There are known limitations with Spek icons appearing on some Salesforce components. Spek icons may not appear or may be inconsistent on:

  • Text within Related Lists
  • Dashboards and Reports

My Spekit sync isn't working. What should I do?

Most syncing issues fall into two categories:

  • IP restrictions in Salesforce: Check that the Salesforce profile used for the Spekit integration does not have IP restrictions that block access.
  • CSP Trusted Site Entry: A CSP trusted site entry is needed in Salesforce to give API access to Spekit. Your Salesforce administrator can confirm this setting.

 

Was this article helpful?
0 out of 0 found this helpful