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
19 changes: 16 additions & 3 deletions ai/slack-bot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@
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 and to every message in channels named `#ask-ai`.
The bot responds to `@` mentions and to every message in channels named `#ask-ai`. You can also configure a custom channel where the bot responds to all messages.

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 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,29 +29,42 @@
<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'?

### Customize the bot's name

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L34

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
## Configure the 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.
By default, the bot responds to every message in any channel named `#ask-ai`. You can customize this behavior to use a specific channel instead.

### Use the default behavior

Create a channel named `#ask-ai` in your workspace. 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 47 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L47

Avoid using 'will'.

### Set a custom Ask AI channel

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**.
1. In the **Ask AI Channel** dropdown, select the channel where you want the bot to respond to all messages.
1. Click **Save**.

The bot will now respond to every message in your selected channel, instead of channels named `#ask-ai`.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L56

Avoid using 'will'.

## Manage the Slack app

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L58

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

Customize the bot's profile picture to match your brand.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L62

Did you really mean 'bot's'?

Image requirements:
- **Format**: PNG or JPEG

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L65

Spell out 'PNG', if it's unfamiliar to the audience.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L65

Spell out 'JPEG', if it's unfamiliar to the audience.
- **Dimensions**: Minimum 256x256 pixels, maximum 2048x2048 pixels
- **File size**: Under 8MB

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L67

Put a nonbreaking space between the number and the unit in '8MB'.

<Frame>
<img src="/images/assistant/slack-configure-light.png" alt="The Slack configuration panel in light mode." className="block dark:hidden" />
Expand Down