Skip to content

Commit 759e030

Browse files
Update ai/slack-bot.mdx
1 parent bad6762 commit 759e030

File tree

1 file changed

+151
-0
lines changed

1 file changed

+151
-0
lines changed

ai/slack-bot.mdx

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
title: "Slack bot"
3+
description: "Get AI-powered documentation assistance directly in Slack"
4+
icon: "slack"
5+
---
6+
7+
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.
8+
9+
## Features
10+
11+
### Direct message support
12+
The bot responds to direct messages from team members, providing a private channel for documentation queries and assistance.
13+
14+
### Real-time notifications
15+
Receive automated notifications about Writer Agent completions, pull request updates, and other documentation-related events directly in your Slack channels.
16+
17+
### Message formatting
18+
The bot properly handles Slack-specific formatting including:
19+
- **Bold text** using single asterisks
20+
- Links formatted as `<url|display text>`
21+
- User mentions as `<@USER_ID>`
22+
- Channel references as `<#CHANNEL_ID>`
23+
24+
### Intelligent responses
25+
Powered by the same AI technology as the web assistant, the Slack bot provides:
26+
- Contextual answers from your documentation
27+
- Source citations with navigable links
28+
- Code examples when relevant
29+
30+
## Setting up the Slack bot
31+
32+
### Prerequisites
33+
- Pro or Custom Mintlify plan
34+
- Slack workspace admin permissions
35+
- Access to your Mintlify dashboard
36+
37+
### Installation steps
38+
39+
1. **Create a Slack app**
40+
- Go to [api.slack.com/apps](https://api.slack.com/apps) and create a new app
41+
- Choose "From scratch" and select your workspace
42+
43+
2. **Configure OAuth scopes**
44+
Add the following bot token scopes in your Slack app settings:
45+
- `im:read` - Read DM channel information
46+
- `im:write` - Send DM responses
47+
- `im:history` - **Critical:** Receive DM message events
48+
- `channels:history` - Receive channel message events
49+
- `groups:history` - Receive private channel events
50+
- `mpim:history` - Receive group DM events
51+
- `app_mentions:read` - Read mentions of the bot
52+
53+
3. **Set up event subscriptions**
54+
Configure these bot event subscriptions in your Slack app:
55+
- `message.im` - Direct message events
56+
- `message.channels` - Public channel messages
57+
- `message.groups` - Private channel messages
58+
- `message.mpim` - Group DM messages
59+
- `app_mention` - When the bot is mentioned
60+
61+
4. **Configure the request URL**
62+
Set your event subscription request URL to your Mintlify webhook endpoint (provided in your dashboard).
63+
64+
5. **Install the app**
65+
Install the app to your workspace and copy the bot token.
66+
67+
6. **Connect to Mintlify**
68+
In your Mintlify dashboard, navigate to the Slack integration settings and provide your bot token and signing secret.
69+
70+
## Using the Slack bot
71+
72+
### Direct messages
73+
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.
74+
75+
**Example:**
76+
```
77+
How do I set up custom domains?
78+
```
79+
80+
The bot will respond with relevant information from your documentation and provide links to the specific pages for more details.
81+
82+
### Channel mentions
83+
Mention the bot in any channel where it's been added to get documentation assistance in context.
84+
85+
**Example:**
86+
```
87+
@docs-bot How do I configure authentication?
88+
```
89+
90+
### Notifications
91+
The bot automatically sends notifications for:
92+
- Writer Agent task completions
93+
- Documentation build status updates
94+
- Pull request reviews and merges
95+
96+
## Dashboard integration
97+
98+
The Slack bot integrates with your Mintlify dashboard to provide:
99+
100+
### Real-time status display
101+
View the current status of your Slack bot integration, including connection health and recent activity.
102+
103+
### Message analytics
104+
Track bot usage patterns, popular queries, and response effectiveness to understand how your team uses documentation.
105+
106+
### Configuration management
107+
Manage bot settings, notification preferences, and channel configurations directly from your dashboard.
108+
109+
## Best practices
110+
111+
### Channel organization
112+
- Add the bot to relevant channels where documentation questions commonly arise
113+
- Create dedicated channels for documentation discussions
114+
- Use thread replies to keep conversations organized
115+
116+
### Query optimization
117+
- Ask specific questions for better responses
118+
- Include context when asking about implementation details
119+
- Use the bot for quick lookups rather than complex troubleshooting
120+
121+
### Team adoption
122+
- Introduce the bot to your team with example queries
123+
- Share useful responses in channels to demonstrate value
124+
- Encourage team members to use the bot for self-service documentation
125+
126+
## Troubleshooting
127+
128+
### Bot not responding
129+
- Verify the bot token is correctly configured in your dashboard
130+
- Check that required OAuth scopes are granted
131+
- Ensure event subscriptions are properly configured
132+
133+
### Missing notifications
134+
- Confirm notification settings in your dashboard
135+
- Verify the bot has access to relevant channels
136+
- Check Slack app permissions for the workspace
137+
138+
### Formatting issues
139+
- The bot automatically handles Slack formatting
140+
- Links and mentions are processed according to Slack standards
141+
- Contact support if you notice persistent formatting problems
142+
143+
## Privacy and security
144+
145+
The Slack bot follows the same privacy and security standards as the web assistant:
146+
- Messages are processed securely and not stored permanently
147+
- Only documentation content is used for responses
148+
- Team conversations remain private to your workspace
149+
- All data transmission is encrypted
150+
151+
For additional security configurations or enterprise requirements, contact your Mintlify account manager.

0 commit comments

Comments
 (0)