Setting up Salesforce

What do I need to set up before connecting Salesforce to Spekit?

Before connecting, you must ensure your Salesforce integration user has the required permissions. If you do not already have a dedicated integration user, one should be created for this process.

Required Salesforce Profile Permissions:

• Modify Metadata Through Metadata API Functions
• API Enabled
• No IP Restrictions: Optional, but recommended for uninterrupted syncing.

How do I initiate the Salesforce connection from Spekit?

After the prerequisites are complete, a Spekit Admin can initiate the connection from within Spekit. This step makes the Spekit OAuth app available in Salesforce for installation.

1. From the Spekit Web App, click Settings.
2. Click Connect.
3. Click Connect to Salesforce.
4. Check the Sync User's profiles checkbox to import the list of Salesforce users who can be invited to Spekit.
   ℹ️ Note: Leave this unchecked if you are connecting an IdP (Okta, OneLogin, Azure, etc.) with SCIM 2.0.
5. Check the confirmation checkbox: I have the required Salesforce permissions.
6. Click Connect a Salesforce Production or Developer Org.
7. You'll be redirected to log in to Salesforce. Enter your Spekit Integration Salesforce username and password.
8. Click Log In.
   ℹ️ Custom Domain: If your company uses a custom domain (e.g. https://somethingcool.my.salesforce.com), click Use Custom Domain in the bottom-right corner, enter your custom domain (e.g. somethingcool), and click Continue.
9. A pop-up will prompt you to Allow Access for the Spekit OAuth app. Click Allow.
10. Allow the initial Salesforce sync to complete before navigating away from the page. This may take a few minutes.

How do I install the Spekit OAuth app in Salesforce?

This step is critical for securely connecting Spekit with your Salesforce instance and preventing common permission errors. A Salesforce Administrator must complete this step after Step 2 has been performed.

1. Log in to Salesforce and open Setup:
   • Click the gear icon ⚙️ in the upper-right corner.
   • Select Setup from the dropdown menu.
2. Navigate to Connected Apps:
   • In the Quick Find search bar on the left, type Connected Apps.
   • From the results, click Connected Apps OAuth Usage.
3. Locate and install the Spekit OAuth app:
   • In the list of connected apps, find Spekit OAuth.
   • Click the Install action on the right side of the page.
   • Follow the prompts to complete the installation.

Once the OAuth app is installed, the Spekit Administrator can proceed with the connection.

What should I know before connecting Spekit to a Salesforce sandbox?

• Each Spekit account can only be connected to one Salesforce org at a time (sandbox, production, or free developer).
• You can test with as many sandboxes as you want - simply create a new Spekit account for each sandbox.
• For ongoing use, we strongly recommend connecting to your Salesforce production org. Spekit does not support Salesforce sandbox refreshes - doing so will break the integration since the Salesforce org and user IDs will change.
• Spekit can transfer content from a sandbox account to production on your behalf when you're ready.

What metadata changes does Spekit track?

Spekit should not be viewed as a metadata backup system, but it does store logs for specific changes made directly in Spekit.

Spekit tracks the following:

• Last Edited On in Spekit
• Last Edited By in Spekit

Spekit also displays the following from Salesforce (not stored as a log):

• Last Synced from Salesforce (last date only)

How do I pull in the latest Salesforce metadata?

As an Admin, you can re-sync metadata from your Salesforce org at any time by going to Settings → Connect and clicking Sync now. You may be asked to re-authenticate by logging into Salesforce.

How do I enable the Modify Metadata permission for the integration user?

The Modify Metadata Through Metadata API Functions permission is set at the Profile level. Follow these steps to enable it:

1. Click the gear icon ⚙️ in the upper-right corner of Salesforce.
2. From the dropdown, click Setup.
3. Under the Administration header, click Users → Profiles.
4. Locate and click on the Profile associated with the Salesforce integration user.
5. Click System Permissions.
6. Click Edit.
7. Scroll down to Modify Metadata Through Metadata API Functions and check the checkbox ☑.
8. Click Save.

How do I enable the API Enabled permission for the integration user?

The API Enabled permission is set at the Profile level. Follow these steps to enable it:

1. Click the gear icon ⚙️ in the upper-right corner of Salesforce.
2. From the dropdown, click Setup.
3. Under the Administration header, click Users → Profiles.
4. Locate and click on the Profile associated with the Salesforce integration user.
5. Click System Permissions.
6. Click Edit.
7. Scroll down to API Enabled and check the checkbox ☑.
8. Click Save.

Does Spekit automatically consume Salesforce API calls?

• Spekit does not automatically run the Sync now process.
• The sync is 100% manually triggered from the Connect page in the Spekit Web App.
• Only run Sync now when changes have been made in the connected Salesforce org that you want to pull into Spekit.

API call estimates per sync:

• As a rough benchmark, 12 imported objects = approximately 170 API calls per sync.
• This can be higher if you have many installed package fields on standard objects or very large objects.
• For larger organizations, this can reach approximately 400 API calls at the upper end - though every implementation is different.