These instructions will walk you through the installation process for the ScreenSteps integration for Slack as well as testing out the integration in Slack. Please refer to our Privacy Policy for information about how ScreenSteps collects, manages, and stores third-party data.
In order to complete these steps you must be able to log into your Slack Workspace as a user who has administrative rights to install Slack applications.
Installation
Navigate to Integrations and click on Slack
Configure Slack
In the dialog that opens, click the Configure button.
Click Next.
Click the Connect button under Slack Connection. This will walk you through the process of installing the ScreenSteps Slack application in your Slack environment.
A new browser tab will open on the Slack website. If you have permission to install the application in your Slack Workspace you will see a screen similar to this. Click Allow.
If you see a screen that only allows you to Request to install then you will need to stop here. A user with permission to install applications in your Slack Workspace must go through this process.
After successfully connecting ScreenSteps to Slack you will see this screen. Once you do you can close the browser tab and return to ScreenSteps.
In ScreenSteps you should now see a green dot next to Slack Connection.
Configure ScreenSteps
Now you need to enter the connection details for ScreenSteps.
- Enter a subdomain for the site you would like to bee able to search in ScreenSteps. Refer to How to find the subdomain for your site if you need help locating it.
- Enter an admin login for the username
- Use an API token scoped to the site whose subdomain you entered above. We recommend creating a new token and naming it Slack. Refer to Generating a ScreenSteps API Token for more info.
Click Finish once you are done.
Success! Your ScreenSteps integration for Slack has now been activated.
Test in Slack
ss-search Slash Command
Now it is time to test everything out in Slack. You should now see the ScreenSteps app in Slack.
Search your ScreenSteps site using the /ss-search slash command.
Type the phrase you would like to search on after the /ss-search slash command. In this example I'm searching on invoices.
After submitting your request the search results will be displayed in a message that is only visible to you. Click on the Insert Link button next to the search result that you want to insert into the discussion you are currently in.
The search results will disappear and a message that is visible to everyone in the discussion will appear with a link to the article.
Request an Article Shortcut
You may have noticed the Request an Article button in the search results. Clicking that button opens a dialog that allows you to submit an article request to your Knowledge Ops team (the people who manage your ScreenSteps knowledge base). You can request an article at any time using the Request an Article shortcut. Just type that phrase into the Jump to field in Slack.
This form will appear. Enter your question and any additional details and then click Submit.
0 Comments
Add your comment