A Spek icon appears next to matching text on a web page, so your team gets the answer without leaving what they are doing. This guide covers how to set that up.
1. How it works
Spekit matches the Label of a Spek against text on the page. Where the text matches, the icon appears.
3 things have to line up:
| Requirement | Why |
|---|---|
| The Label matches the page text exactly | Matching is exact. "Lead Source" does not match "Lead source" |
| The Spek's Topic is linked to the website's domain | Without this, the Spek exists but never appears |
| Spek icons are turned on in the extension | This is a per-user setting |
ℹ️ Note: This works in most web applications using Chrome. Some apps have limited compatibility. Slides Speks can be embedded the same way as Doc Speks, as long as the label and the Topic domain match.
2. Create the Spek
- Create a Spek in the Web App or the Chrome Extension. See How to create a Spek.
- Enter the Label. This must match the page text exactly.
- Enter the definition. Use the editor to format it.
- Click the ⚙️ gear icon and add the Spek to 1 or more Topics.
- Click Save, then Publish.
⚠️ The icon appears everywhere that text occurs. If "Lead Source" shows up in 4 places on a page, the same Spek appears in all 4.
💡 Pro Tip: Copy the label text straight from the page rather than typing it. That avoids a mismatch from a capital letter or an extra space.
ℹ️ Note: For Salesforce fields, picklists, and objects you have imported, you do not need to create anything. Spekit already made an empty Spek for you. See How to create a Spek.
3. Link the Topic to your website
The Spek's Topic must have the website's domain linked to it, or the icon will not appear.
- Open the Topic and click Edit.
- On the Settings tab, find Related domains.
- Enter the website URL.
- Tick Include subdomain and domain or Include path and domain if you need either.
- Click Save changes.
4. Turn on Spek icons
This is a per-user setting. Each person who should see the icons does this once.
- Open the Chrome Extension, also called Sidekick.
- Click the ellipsis (...).
- Click Settings.
- Turn on Display Spek Icons.
5. Best practices
Most icons that fail to appear come down to 1 of these.
| Practice | Why it matters |
|---|---|
| Match the label exactly, including case | Matching is literal. A capital letter is enough to break it |
| Use a label that is specific | A label like "Status" matches everywhere and clutters the page |
| Link the domain before you tell your team | The Spek will exist but stay invisible until the Topic has the domain |
| Check the Topic's Team access | Someone not on a Team with access to that Topic will never see the icon |
| Tell people to turn icons on | It is a per-user setting, so yours being on says nothing about theirs |