Skip to content
Closed
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
17 changes: 17 additions & 0 deletions ai/slack-bot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
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.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L11

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

The bot can only see messages in channels you specifically add it to. It does not have global read access to your workspace.

Check warning on line 13 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L13

Use 'doesn't' instead of 'does not'.

The bot responds to `@` mentions or to all messages in a specific channel that you configure.

Expand All @@ -19,7 +19,7 @@
## 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 22 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L22

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

1. Navigate to the [Integrations](https://dashboard.mintlify.com/products/assistant/settings/integrations) tab of the **Assistant Configurations** page in your dashboard.
Expand All @@ -29,7 +29,7 @@
<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 `@mintlify-assistant`.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L32

Did you really mean 'bot's'?

## Create an `#ask-ai` channel

Expand All @@ -42,8 +42,25 @@
<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

Check warning on line 45 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L45

'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.

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.

## Remove the Slack app

Check warning on line 51 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L51

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

You can remove the Slack Assistant installation from your workspace through the dashboard:

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 **Configure** to open the configuration menu.
1. Click **Remove** to delete the installation.

When you remove a Slack Assistant installation:

- The Mintlify app is automatically uninstalled from your Slack workspace
- All installation data associated with your workspace is permanently deleted from Mintlify's database
- The bot will no longer respond to messages in your workspace

Check warning on line 63 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L63

Avoid using 'will'.
- This action cannot be undone

Check warning on line 64 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L64

Use 'can't' instead of 'cannot'.

If you want to use the Slack Assistant again after removing it, you'll need to reinstall it by following the setup steps above.

Check warning on line 66 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L66

Use 'preceding' instead of 'above'.