Bring your Spekit knowledge base into Slack! Search answers, share resources, and create knowledge without ever leaving Slack. Use a simple /spekit command to boost productivity and get your time back.
📌 Quick-Jump Topics
- Overview of the Spekit Slack Integration: What you can do with Spekit in Slack
- How to Install and Connect Spekit and Slack: Prerequisites and setup steps
- What Are the Spekit Slack Commands: Full list of available slash commands
- How to Create Speks from Slack: Using slash commands and the overflow menu
- How to Search Spekit from Slack: Finding and viewing Speks without leaving Slack
- How to Post Speks to Channels from Slack: Sharing Speks directly in a channel
- How to Copy Links to a Spek from Slack: Getting a shareable Spek link
- How to Troubleshoot the Spekit Slack Integration: Fixing common issues
- What Are the Documented Slack Limitations: Known constraints to be aware of
Overview of the Spekit Slack Integration
What can I do with the Spekit Slack integration?
The Spekit Slack integration turns your one-off Slack responses into knowledge that lives forever. Right-click any message in Slack to automatically create documentation that's always accessible in Spekit.
Have a question while in Slack? Don't dig through Google Docs, PowerPoints, and emails for answers. Type /spekit followed by a keyword to search your entire knowledge base and paste the answer or resource link directly into Slack in seconds.
How to Install and Connect Spekit and Slack
What are the prerequisites before setting up the integration?
- The user setting up the connection must have Slack Workspace Owner permissions.
- The user setting up the connection must have Spekit Account Admin permissions.
- The Slack email address must exactly match the user's Spekit account email address.
How do I connect Spekit and Slack?
- Go to the Connect tab in the Spekit Web App and locate the Slack app.
- Click the Add to Slack button.
- Click the Allow button to grant Spekit permission to connect to your Slack workspace.
- Click Open Slack. Spekit will appear under the Apps section in the bottom-left of Slack.
- Click Spekit in the Apps section.
- Setup is complete. You will see the Spekit tutorial with a list of commands to test.
What Are the Spekit Slack Commands?
What slash commands are available in the Spekit Slack integration?
Spekit Admins and Experts can also create Speks directly from a Slack message by clicking the ellipsis (…) menu on any message, clicking on Connect to apps and selecting Create a Spek. Spekit will pre-fill the Spek with the message text.
Below is the full list of available Spekit slash commands:
| Slack Command | Description |
|---|---|
| /spekit connect | Connects Spekit to Slack for the first time. Only needs to be run once. This will auto-map all Slack users with a matching email address in your Spekit organization. Users not registered on both Slack and Spekit at the time of auto-mapping will need to run /spekit connect manually to log in. |
| /spekit create | Creates a new Spek. Available only to Spekit Admins and Experts. |
| /spekit [KEYWORD] | Searches Spekit for Speks matching the keyword you enter. Example: /spekit searching LinkedIn for leads |
| /spekit info | Shows which user you are logged in as and which Spekit organization you are connected to. |
| /spekit help | Displays the full list of available Spekit commands and how to use them within Slack. |
| /spekit logout | Logs the current user out of their Spekit integration in Slack. |
| /spekit disconnect |
Disconnects all Spekit users from that Slack account. This action is permanent and should only be used when migrating from one Spekit account to another. Only Account Admins can run this command. ⚠️ Warning: This command is permanent and will disconnect all users. Use with caution.
|
How to Create Speks from Slack
Option 1: Create a Spek using a slash command
- In any Slack channel or direct message, type /spekit create followed by your keyword or topic.
- Spekit will open a form for you to fill in the Spek details.
- Complete the form and save your new Spek.
Option 2: Create a Spek from an existing Slack message
- Hover over the message you want to turn into a Spek.
- Click the ellipsis (…) overflow menu that appears.
- Hover over the Connect to apps option.
- Select Create a Spek. Spekit will automatically pre-populate the Spek definition with the message text.
- Review and save the Spek.
How to Search Spekit from Slack
How do I search for a Spek without leaving Slack?
- In any Slack channel or direct message, type /spekit followed by your keyword. For example: /spekit how to create a lead
- Spekit will return a list of matching results - visible only to you.
- Browse the results and click on the Spek you want to view.
- Click Show more to load additional search results if needed.
- Click Open in the Spekit app to view the full Spek in Spekit, or click View Spek in Slack 👀 to read the Spek content directly inside Slack without switching apps.
How to Post Speks to Channels from Slack
How do I share a Spek directly into a Slack channel?
- Search for the Spek using the /spekit [keyword] command and locate it in the search results.
- Click the Post to this channel button next to the Spek.
- The Spek will appear in the channel, visible to all members.
How to Copy Links to a Spek from Slack
How do I get a direct link to a Spek from within Slack?
- Search for the Spek and click View Spek in Slack 👀.
- Right-click on the name of the Spek.
- Select Copy Link Address.
- Open a new tab in your browser, paste the URL into the address bar, and press Enter to view the full Spek.
How to Troubleshoot the Spekit Slack Integration
What should I do if I receive an error when trying to create a Spek from Slack?
If you receive an error message when attempting to create a Spek from Slack, your Spekit account or organization may not be correctly linked. Follow these steps to resolve it:
- In Slack, type /spekit info to see which user and organization you are currently connected to.
- Verify that both the user and organization shown are correct.
- If either is incorrect, type /spekit logout to log out.
- Then type /spekit connect to reconnect with the correct account.
What Are the Documented Slack Limitations?
Are there any known limitations with the Spekit Slack integration?
Yes, there are two known Slack API limitations that affect the Spekit integration:
- Topic dropdown limited to 100 options: When creating a Spek from Slack, the Topic dropdown is limited to 100 options. If your Spekit instance contains more than 100 Topics, not all Topics will be visible in the Slack dropdown. (Slack's Developer Documentation)
- 3,000-character display limit: Slack has a 3,000-character limit for content displayed in a message. If a Spek contains more than 3,000 characters, the content will be truncated when viewed in Slack. (Slack's Developer Documentation)