Skip to content
Closed
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
151 changes: 151 additions & 0 deletions ai/slack-bot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
---
title: "Slack bot"
description: "Get AI-powered documentation assistance directly in Slack"
icon: "slack"
---

The Slack bot brings Mintlify's AI assistant directly to your team's Slack workspace, enabling seamless documentation assistance without leaving your communication flow. Team members can ask questions about your documentation and receive intelligent responses with source citations, all within Slack.

## Features

### Direct message support
The bot responds to direct messages from team members, providing a private channel for documentation queries and assistance.

### Real-time notifications
Receive automated notifications about Writer Agent completions, pull request updates, and other documentation-related events directly in your Slack channels.

### Message formatting
The bot properly handles Slack-specific formatting including:
- **Bold text** using single asterisks
- Links formatted as `<url|display text>`
- User mentions as `<@USER_ID>`
- Channel references as `<#CHANNEL_ID>`

### Intelligent responses
Powered by the same AI technology as the web assistant, the Slack bot provides:
- Contextual answers from your documentation
- Source citations with navigable links
- Code examples when relevant

## Setting up the Slack bot

### Prerequisites
- Pro or Custom Mintlify plan
- Slack workspace admin permissions

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

Use 'administrator' instead of 'admin'.
- Access to your Mintlify dashboard

### Installation steps

1. **Create a Slack app**
- Go to [api.slack.com/apps](https://api.slack.com/apps) and create a new app
- Choose "From scratch" and select your workspace

2. **Configure OAuth scopes**
Add the following bot token scopes in your Slack app settings:
- `im:read` - Read DM channel information
- `im:write` - Send DM responses
- `im:history` - **Critical:** Receive DM message events
- `channels:history` - Receive channel message events
- `groups:history` - Receive private channel events
- `mpim:history` - Receive group DM events
- `app_mentions:read` - Read mentions of the bot

3. **Set up event subscriptions**
Configure these bot event subscriptions in your Slack app:
- `message.im` - Direct message events
- `message.channels` - Public channel messages
- `message.groups` - Private channel messages
- `message.mpim` - Group DM messages
- `app_mention` - When the bot is mentioned

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L59

In general, use active voice instead of passive voice ('is mentioned').

4. **Configure the request URL**
Set your event subscription request URL to your Mintlify webhook endpoint (provided in your dashboard).

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

Use parentheses judiciously.

5. **Install the app**
Install the app to your workspace and copy the bot token.

6. **Connect to Mintlify**
In your Mintlify dashboard, navigate to the Slack integration settings and provide your bot token and signing secret.

## Using the Slack bot

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L70

'Using the Slack bot' should use sentence-style capitalization.

### Direct messages
Send a direct message to the bot with any question about your documentation. The bot will search your docs and provide a comprehensive answer with source links.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L73

Avoid using 'will'.

**Example:**
```
How do I set up custom domains?
```

The bot will respond with relevant information from your documentation and provide links to the specific pages for more details.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L80

Avoid using 'will'.

### Channel mentions
Mention the bot in any channel where it's been added to get documentation assistance in context.

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L83

In general, use active voice instead of passive voice ('been added').

**Example:**
```
@docs-bot How do I configure authentication?
```

### Notifications
The bot automatically sends notifications for:
- Writer Agent task completions
- Documentation build status updates
- Pull request reviews and merges

## Dashboard integration

The Slack bot integrates with your Mintlify dashboard to provide:

### Real-time status display
View the current status of your Slack bot integration, including connection health and recent activity.

### Message analytics
Track bot usage patterns, popular queries, and response effectiveness to understand how your team uses documentation.

### Configuration management
Manage bot settings, notification preferences, and channel configurations directly from your dashboard.

## Best practices

### Channel organization
- Add the bot to relevant channels where documentation questions commonly arise
- Create dedicated channels for documentation discussions
- Use thread replies to keep conversations organized

### Query optimization
- Ask specific questions for better responses
- Include context when asking about implementation details
- Use the bot for quick lookups rather than complex troubleshooting

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L119

Did you really mean 'lookups'?

### Team adoption
- Introduce the bot to your team with example queries
- Share useful responses in channels to demonstrate value
- Encourage team members to use the bot for self-service documentation

## Troubleshooting

### Bot not responding
- Verify the bot token is correctly configured in your dashboard
- Check that required OAuth scopes are granted

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L130

In general, use active voice instead of passive voice ('are granted').
- Ensure event subscriptions are properly configured

### Missing notifications
- Confirm notification settings in your dashboard
- Verify the bot has access to relevant channels
- Check Slack app permissions for the workspace

### Formatting issues
- The bot automatically handles Slack formatting
- Links and mentions are processed according to Slack standards

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L140

In general, use active voice instead of passive voice ('are processed').
- Contact support if you notice persistent formatting problems

## Privacy and security

The Slack bot follows the same privacy and security standards as the web assistant:
- Messages are processed securely and not stored permanently

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L146

In general, use active voice instead of passive voice ('are processed').
- Only documentation content is used for responses

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L147

In general, use active voice instead of passive voice ('is used').
- Team conversations remain private to your workspace
- All data transmission is encrypted

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

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L149

In general, use active voice instead of passive voice ('is encrypted').

For additional security configurations or enterprise requirements, contact your Mintlify account manager.
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"group": "AI optimization",
"pages": [
"guides/assistant",
"ai/slack-bot",
"ai/llmstxt",
"ai/contextual-menu",
"ai/model-context-protocol",
Expand Down