mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
52 lines
3.1 KiB
Plaintext
52 lines
3.1 KiB
Plaintext
---
|
|
title: "Slack bot"
|
|
description: "Add a bot to your Slack workspace that answers questions based on your documentation."
|
|
keywords: ["bot", "workspace", "Q&A", "Slack", "app"]
|
|
---
|
|
|
|
<Info>
|
|
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app) with access to the assistant.
|
|
</Info>
|
|
|
|
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.
|
|
|
|
The bot can only see messages in channels you specifically add it to. It does not have global read access to your workspace.
|
|
|
|
The bot responds to `@` mentions or to all messages in a specific channel that you configure.
|
|
|
|
Each message sent by the bot counts toward your assistant message usage.
|
|
|
|
## Set up the Slack app
|
|
|
|
<Note>
|
|
You can only install the Slack app once per workspace. If you have multiple Mintlify deployments, you can only connect one deployment at a time to a workspace. You must disconnect the app from one deployment before connecting it to another.
|
|
</Note>
|
|
|
|
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it.
|
|
|
|
1. Navigate to the [Assistant](https://dashboard.mintlify.com/products/assistant) page in your dashboard.
|
|
1. In the Slack card, click **Configure**. This opens Slack.
|
|
<Frame>
|
|
<img src="/images/assistant/connected-apps-light.png" alt="The connected apps section of the assistant page." className="block dark:hidden" />
|
|
<img src="/images/assistant/connected-apps-dark.png" alt="The connected apps section of the assistant page." className="hidden dark:block" />
|
|
</Frame>
|
|
1. Follow the Slack prompts to add the app to your workspace.
|
|
1. Mention the bot to add it to a channel. The bot's default name is `@mintlify-assistant`.
|
|
|
|
## Create an `#ask-ai` channel
|
|
|
|
To help your users quickly get answers to their questions, the bot can reply to every message in a channel that you choose. By default, the bot replies to every message in channels named `#ask-ai`. Create an `#ask-ai` channel and let your users know that the bot replies to messages in that channel. See [Create a channel](https://slack.com/help/articles/201402297-Create-a-channel) in the Slack Help Center for more information.
|
|
|
|
If you want the bot to reply to messages in a different channel, select a channel in the Slack bot [configuration menu](https://dashboard.mintlify.com/products/assistant/settings/integrations).
|
|
|
|
<Frame>
|
|
<img src="/images/assistant/slack-configure-light.png" alt="The Slack configuration panel in light mode." className="block dark:hidden" />
|
|
<img src="/images/assistant/slack-configure-dark.png" alt="The Slack configuration panel in dark mode." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
## Manage the Slack app
|
|
|
|
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.
|
|
|
|
In the Slack bot configuration menu, customize the bot by changing its avatar or name, and choose which channel it automatically replies to all messages in.
|