Ready to start creating content in Salesforce with Spekit? This guide covers how to sync help text, import objects and picklist values, define field Speks, and decide when to use a Field Spek vs. a Custom Spek.
📌 Quick-Jump Topics
- Salesforce Sync Help Text: How help text is imported and used in Spekit
- How to Import Salesforce Objects into Spekit: Bringing in standard, custom, and package objects
- How to Import Picklist Values in Spekit: Selectively importing and defining picklist values
- How to Easily Define Field Speks: Adding definitions to imported Salesforce fields
- When to Use a Field Spek vs. a Custom Spek: Choosing the right Spek type for your content
Salesforce Sync Help Text
What happens to Salesforce help text when the initial sync runs?
When the initial Salesforce connection is established, the sync process gathers objects and fields from Salesforce and makes them available in Spekit. As part of this process, help text from Salesforce fields is imported as read-only metadata.
The Spekit Account Admin can easily copy the imported Help Text to use as the definition for a field Spek, making it visible on field Speks associated with Salesforce objects imported from Manage Objects.
How to Import Salesforce Objects into Spekit
How do I import Standard, Custom, Installed Package, and Salesforce System objects into Spekit?
Importing objects pulls in all associated fields into Spekit, allowing you to document them for your team. Spekit will create shell Speks for each field - these shell Speks cannot be deleted.
To import objects:
- Click Settings.
- Click Connect.
- Click Manage Objects.
- Click on the objects you wish to import (for example: Contract, Lead, Opportunity, and Order).
- Click the blue Import selected objects button.
⚠️ Important: Do not navigate away from the Web App while the sync process is running. It may take a few minutes if you are importing a large number of objects.
- When the sync finishes, you will see a confirmation message at the bottom of the screen: Object import complete! You will then be redirected to the Content page.
- Click Filter and filter by Spek Type = Objects to view all your imported objects.
- Click into an Object name or the Fields (#) count to the right to see the related content.
How to Import Picklist Values in Spekit
How do I import picklist values for a Salesforce field?
When importing objects from Salesforce, Spekit does not automatically import field-level picklist values. You can choose which picklist values to import and when, giving you full control over what gets documented.
- Click Team Hub.
- Select Content.
- Click List View.
- Click Filter.
- Scroll down to Spek type and select Salesforce Field.
- Click Apply Filters.
- Select a field whose picklist values you want to import (for example, the Type or Incumbent Solution field).
- A new screen will appear. Click Import Picklist Values.
- A new screen will appear where you can define each individual picklist value and add a business process. You have two options:
- Define all picklist values at once after importing.
- Define each picklist value individually after importing.
- Click Import to Wiki.
Once imported, you can view the picklist values in your Dictionary along with their corresponding Parent Field.
How to Easily Define Field Speks
How do I add a definition to a Salesforce field Spek?
- Open a record page in Salesforce (for example, an Opportunity record).
- Hover over the text of a field label with your mouse, right-click on it, and choose Spekit from the right-click context menu. The Spekit Chrome Extension will open and automatically search for the item you clicked.
- Click the name of the field Spek that matches what you highlighted on the page (for example, the Stage field).
- Click Add definition. A text box will open in the center of the page.
- Type your definition for the field Spek.
- Click Save.
After saving, refresh your Chrome browser to see the Spekit icon appear next to the field label you defined.
When to Use a Field Spek vs. a Custom Spek
How do I decide whether to use a Field Spek or a Custom Spek?
Use Field Speks whenever they are available. Field Speks are directly connected to their parent object in Salesforce and do not need to be placed in a Topic - they appear automatically on the associated field in Salesforce.
Use a Custom Spek when you need to add a Spek to text that is not a Salesforce field - for example, the header of a Related List. To do this:
- Create a new Topic and assign the Teams that should be able to view it.
- Create a new Custom Spek whose label exactly matches the Related List name, and relate it to the Salesforce object. This will cause the Spekit icon to appear on the record.