|
1 | 1 | --- |
2 | 2 | title: "Slack app" |
3 | | -description: "Add a bot that searches your docs to answers questions in your Slack workspace." |
4 | | -keywords: ["Slack bot", "workspace", "questions"] |
| 3 | +description: "Add a bot to your Slack workspace that answers questions based on your documentation." |
| 4 | +keywords: ["bot", "workspace", "Q&A", "Slack"] |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | <Info> |
8 | | - The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app). |
| 8 | + The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant. |
9 | 9 | </Info> |
10 | 10 |
|
11 | | -The Slack app adds a bot to your Slack workspace that can search your documentation and answer users' questions. The bot responds to direct messages, @mentions, and to any questions in a channel specifically named `#ask-ai`. The bot's name is `@yourprojectname-assistant`. So if your project name is Mintlify, the bot's name is `@mintlify-assistant`. |
| 11 | +The Slack app adds a bot to your workspace that supports your community with real-time answers. The bot uses the Mintlify assistant to search your docs and provide accurate, cited responses, so it is always up-to-date. |
12 | 12 |
|
13 | | -The Slack app can incur costs: either using your AI assistant credits or incurring overages. |
| 13 | +The bot responds to `@` mentions and to every message in channels named `#ask-ai`. |
| 14 | + |
| 15 | +Each message sent by the bot counts toward your assistant message usage. |
14 | 16 |
|
15 | 17 | ## Set up the Slack app |
16 | 18 |
|
17 | 19 | <Note> |
18 | 20 | If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it. |
19 | 21 | </Note> |
20 | 22 |
|
21 | | -1. Navigate to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard. |
22 | | -2. Select **Connect** in the Slack Integration card. |
23 | | -3. Follow the Slack prompts to add the app to your workspace. |
24 | | -4. Test that the bot is working and responds when you: |
25 | | - - Send a direct message to the bot. |
26 | | - - Mention the bot in a channel. |
27 | | - - Create an `#ask-ai` channel, add the bot, and ask a question. |
| 23 | +1. Navigate to the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab of the **Assistant Configurations** page in your dashboard. |
| 24 | +1. In the Slack card, click **Connect**. This opens Slack. |
| 25 | + <Frame> |
| 26 | + <img src="/images/assistant/slack-connect-light.png" alt="The Connect button in the Slack card in light mode." className="block dark:hidden" /> |
| 27 | + <img src="/images/assistant/slack-connect-dark.png" alt="The Connect button in the Slack card in dark mode." className="hidden dark:block" /> |
| 28 | + </Frame> |
| 29 | +1. Follow the Slack prompts to add the app to your workspace. |
| 30 | +1. Mention the bot to add it to a channel. The bot's default name is `@mintlify-assistant`. |
| 31 | + |
| 32 | +### Customize the bot's name |
| 33 | + |
| 34 | +1. In Slack, select the Mintlify app in the **Apps** menu. |
| 35 | +1. Click **About**. |
| 36 | +1. Click **Configuration**. This opens the app configuration page in a web browser. |
| 37 | +1. In the **Bot User** section, edit the bot name. |
| 38 | + |
| 39 | +## Create an `#ask-ai` channel |
| 40 | + |
| 41 | +To help your users quickly get answers to their questions, create a channel named `#ask-ai`. The bot will respond to every message in that channel. See [Create a channel](https://slack.com/help/articles/201402297-Create-a-channel) in the Slack Help Center for more information. |
| 42 | + |
| 43 | +## Manage the Slack app |
| 44 | + |
| 45 | +After you add the app to your workspace, you can manage or remove the app from the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab. |
0 commit comments