Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 30 additions & 12 deletions ai/slack-app.mdx
Original file line number Diff line number Diff line change
@@ -1,27 +1,45 @@
---
title: "Slack app"
description: "Add a bot that searches your docs to answers questions in your Slack workspace."
keywords: ["Slack bot", "workspace", "questions"]
description: "Add a bot to your Slack workspace that answers questions based on your documentation."
keywords: ["bot", "workspace", "Q&A", "Slack"]
---

<Info>
The Slack app is available for [Pro and Custom plans](https://mintlify.com/pricing?ref=slack-app).
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 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`.
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.

Check warning on line 11 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L11

Use 'it's' instead of 'it is'.

The Slack app can incur costs: either using your AI assistant credits or incurring overages.
The bot responds to `@` mentions and to every message in channels named `#ask-ai`.

Each message sent by the bot counts toward your assistant message usage.

## Set up the Slack app

<Note>
If your Slack Workspace Owner requires admin approval to install apps, ask them to approve the Mintlify Slack app before you add it.

Check warning on line 20 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L20

Use 'administrator' instead of 'admin'.
</Note>

1. Navigate to the [Add-ons](https://dashboard.mintlify.com/products/addons) page of your dashboard.
2. Select **Connect** in the Slack Integration card.
3. Follow the Slack prompts to add the app to your workspace.
4. Test that the bot is working and responds when you:
- Send a direct message to the bot.
- Mention the bot in a channel.
- Create an `#ask-ai` channel, add the bot, and ask a question.
1. Navigate to the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab of the **Assistant Configurations** page in your dashboard.
1. In the Slack card, click **Connect**. This opens Slack.
<Frame>
<img src="/images/assistant/slack-connect-light.png" alt="The Connect button in the Slack card in light mode." className="block dark:hidden" />
<img src="/images/assistant/slack-connect-dark.png" alt="The Connect button in the Slack card in dark mode." 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 TODO:

Check warning on line 30 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L30

Did you really mean 'bot's'?

### Customize the bot's name

Check warning on line 32 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L32

Did you really mean 'bot's'?

1. In Slack, select the Mintlify app in the **Apps** menu.
1. Click **About**.
1. Click **Configuration**. This opens the app configuration page in a web browser.
1. In the **Bot User** section, edit the bot name.

## Create an `#ask-ai` channel

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.

Check warning on line 41 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L41

Avoid using 'will'.

## Manage the Slack app

Check warning on line 43 in ai/slack-app.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-app.mdx#L43

'Manage the Slack app' should use sentence-style capitalization.

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.
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@
"insights/feedback"
]
},
"ai/slack-app",
"ai/llmstxt",
"ai/model-context-protocol",
"optimize/seo",
Expand Down
Binary file added images/assistant/slack-connect-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/assistant/slack-connect-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.