Create a Slack Knowledge Base with Spekit. Search answers, share resources, and create knowledge without ever leaving Slack. Answer questions in Slack in seconds with a simple /spekit command to boost productivity and get your time back.
Overview of the Spekit Slack Integration
Turn your one-off Slack responses into knowledge that lives forever. Right-click any content in Slack to automatically create documentation that’s always accessible.
One command to search your entire knowledge base.
Have a question while in Slack? Looking for a particular resource? Don’t dig through Google Docs, Powerpoints, and emails for answers. Type /Spekit to search your entire knowledge base and paste the answer or resource link in Slack to share in seconds.
How to install and connect Spekit and Slack
Prerequisites for setup:
- 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 their Spekit account email address.
Locate the Slack app from the Connect tab in the Spekit Web App.
1.) Click the Add to Slack button.
2.) Click the Allow button.
3.) Click Open Slack. Spekit will appear below the Apps header on the bottom left of Slack.
4.) Click Spekit.
5.) Setup is complete. You will see the Spekit tutorial complete with commands to test.
What are the Spekit Slack commands?
Spekit Admins and Experts can create Speks directly from a message by clicking the ellipses menu on each message and choosing “Create a Spek.” We’ll pre-fill with the message text.
Slack Commands:
|
Slack Command |
Description |
|
/spekit connect |
This command only needs to be run once. This command connects Spekit to Slack for the first time. A Slack user will use this command to connect to their Spekit instance. NOTE: For your convenience, this will connect all Slack users with a matching email address in that Organization and enable Spekit for Slack for all. The Disconnect and Connect commands will have to be used for auto-mapping all users. For users not registered on both slack and Spekit when the organization is auto-mapped the first time, they will need to use Connect to log in manually. |
|
/spekit create :new: |
Creates a new Spek. Available only to Spekit Admins and Experts. |
|
/spekit KEYWORD :mag: |
Searches Spekit for answers for the keyword you enter, ex: /spekit searching LinkedIn for leads |
|
/spekit info |
This command shows who you are logged in as and to which organization. |
|
/spekit help |
This shows our list of commands available and how to use them within Slack. |
|
/spekit logout |
This logs the user out of their Spekit integration in slack. |
|
/spekit disconnect |
WARNING: This permanent command disconnects all Spekit users from that Slack account. You can only use when you migrate from one Spekit account to another. Only account Admins can use this command. |
How to create Speks from Slack
1.) Use a slash command to create a Spek Spekit.
Use the /Spekit create "keyword" command - Creates a new Spek. Creation is available only to Spekit Admins and Experts.
Use case: About to answer a question over slack? Save "future you" time by creating a Spek and posting it directly in Slack. This will not only save you documenting time but also encourage your team first to check Spekit for answers.
2.) Use the overflow menu to Create a Spek from an existing message.
Use case: Slack can be a treasure trove of answers that always go unused. Once you've answered a question - use the overflow menu to Create a Spek from that message. It'll auto-populate the definition for you so you can re-use the answer in the future.
How to search Spekit from Slack
1.) Use a slash command to search Spekit. Use the /spekit KEYWORD command - Searches Spekit for Speks that match the keyword you enter, ex: /spekit lead info.
Use case: About to slack someone for an answer? Save yourself (and them) time by first searching Spekit - right from within slack:
- Search /spekit how to create a lead
- See the results (visible only to you)
- View the different Speks and pick the one you want
- Click Show more to see additional search results
- Post to channel
2.) Opens Speks in the Spekit app. Click Open in the Spekit app to view the Spek posted in the channel.
3.) View Spek in Slack 👀. Click View Spek in Slack 👀 to see the posted Spek without ever leaving Slack!
View from Spekit:
View from Slack:
How to post Speks to channels from Slack
1.) Locate the Spek from the search results.
2.) Click the Post to this channel button.
3.) The selected Spek magically appears in Slack!
How to copy links to a Spek from Slack
1.) Click View Spek in Slack 👀.
2.) Right-click on the name of the Spek.
3.) Left-click Copy Link Address.
4.) Click to open a new tab in Chrome.
5.) Right-click and paste into the new tab to view the Spek.
How to troubleshoot the Spekit Slack Integration
Issue: You receive this message when trying to create a Spek from Slack.
1.) In Slack, type: /spekit info
2.) Verify the Org and user are correct
3.) If either is wrong, type: /spekit logout
4.) Then type: /spekit connect
What are the documented Slack limitations?
When creating a Spek from Slack, the Topic drop-down is limited to 100 options, so if your Spekit instance contains over 100 Topics, you may not be able to see all Topics in Slack.
Slack has a 3000-character limit for content displayed so if a Spek has over 3000 characters in it then we truncate the Spek if viewed in Slack.