Skip to content

Commit 190923f

Browse files
Update ai/assistant-integrations.mdx
Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
1 parent 60ed58b commit 190923f

File tree

1 file changed

+166
-0
lines changed

1 file changed

+166
-0
lines changed

ai/assistant-integrations.mdx

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
---
2+
title: "Assistant integrations"
3+
description: "Connect Discord and Slack to bring AI-powered documentation assistance to your community channels."
4+
keywords: ["Discord integration", "Slack integration", "AI assistant", "community support", "chat integration"]
5+
---
6+
7+
<Info>
8+
Assistant integrations are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=assistant).
9+
</Info>
10+
11+
## About assistant integrations
12+
13+
Connect your Discord servers and Slack workspaces to the Mintlify Assistant to provide AI-powered documentation support directly in your community channels. The assistant answers questions about your documentation using the same agentic RAG technology that powers the embedded assistant on your docs site.
14+
15+
When users ask questions in connected channels, the assistant:
16+
17+
* **Searches your documentation** to find relevant information and provide accurate answers.
18+
* **Cites sources** with links back to your documentation pages.
19+
* **Generates code examples** to help users implement solutions.
20+
21+
Each message sent to the assistant in Discord or Slack counts toward your plan's message allowance, just like messages from your embedded assistant.
22+
23+
## Access integrations
24+
25+
Manage your assistant integrations from the dashboard:
26+
27+
1. Navigate to your [dashboard](https://dashboard.mintlify.com).
28+
2. Select **Assistant** from the products menu.
29+
3. Click the **Integrations** tab.
30+
31+
<Frame>
32+
<img src="/images/assistant/integrations-tab-light.png" alt="The assistant integrations tab in the dashboard." className="block dark:hidden" />
33+
<img src="/images/assistant/integrations-tab-dark.png" alt="The assistant integrations tab in the dashboard." className="hidden dark:block" />
34+
</Frame>
35+
36+
The integrations page displays all available integrations and their connection status. Connected integrations appear in the **Connected apps** section, while available integrations appear in the **All Apps** section.
37+
38+
## Connect Discord
39+
40+
Connect your Discord server to enable the Mintlify Assistant bot in your channels.
41+
42+
### Prerequisites
43+
44+
- Admin permissions on your Discord server.
45+
- An active Mintlify Pro or Custom plan.
46+
47+
### Connect your server
48+
49+
1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations) in your dashboard.
50+
2. Find **Discord** in the integrations list.
51+
3. Click **Connect**.
52+
4. Sign in to Discord if prompted.
53+
5. Select the server where you want to add the assistant.
54+
6. Review the permissions and click **Authorize**.
55+
56+
The assistant bot is added to your Discord server. You'll see a success message and Discord will appear in the **Connected apps** section.
57+
58+
### Configure Discord channels
59+
60+
After connecting your server, configure which channels the assistant can access:
61+
62+
1. In the integrations list, click **Configure** next to Discord.
63+
2. Select the channels where you want the assistant to respond to questions.
64+
3. Save your configuration.
65+
66+
The assistant monitors selected channels and responds when users ask questions about your documentation.
67+
68+
## Connect Slack
69+
70+
Connect your Slack workspace to enable the Mintlify Assistant in your channels.
71+
72+
### Prerequisites
73+
74+
- Admin permissions on your Slack workspace.
75+
- An active Mintlify Pro or Custom plan.
76+
77+
### Connect your workspace
78+
79+
1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations) in your dashboard.
80+
2. Find **Slack** in the integrations list.
81+
3. Click **Connect**.
82+
4. Sign in to Slack if prompted.
83+
5. Select the workspace where you want to add the assistant.
84+
6. Review the permissions and click **Allow**.
85+
86+
The assistant is added to your Slack workspace. You'll see a success message and Slack will appear in the **Connected apps** section.
87+
88+
### Configure Slack channels
89+
90+
After connecting your workspace, configure which channels the assistant can access:
91+
92+
1. In the integrations list, click **Configure** next to Slack.
93+
2. Select the channels where you want the assistant to respond to questions.
94+
3. Save your configuration.
95+
96+
The assistant monitors selected channels and responds when users ask questions about your documentation.
97+
98+
## Manage integrations
99+
100+
### View connection status
101+
102+
The integrations page shows the connection status for each integration. Connected integrations display a **Connected** badge and appear in the **Connected apps** section at the top of the page.
103+
104+
### Disconnect an integration
105+
106+
To disconnect Discord or Slack:
107+
108+
1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations).
109+
2. Find the integration in the **Connected apps** section.
110+
3. Click **Configure**.
111+
4. Click **Disconnect** and confirm.
112+
113+
The assistant stops responding in the disconnected platform's channels.
114+
115+
### Reconfigure channels
116+
117+
Update which channels the assistant monitors:
118+
119+
1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations).
120+
2. Find the integration in the **Connected apps** section.
121+
3. Click **Configure**.
122+
4. Update your channel selections.
123+
5. Save your changes.
124+
125+
## Usage and billing
126+
127+
Messages sent to the assistant in Discord and Slack count toward your plan's message allowance. Monitor your usage from the [Assistant dashboard](https://dashboard.mintlify.com/products/assistant).
128+
129+
If you exceed your message allowance, additional messages incur overage charges according to your plan. Set spending limits in the [Billing tab](https://dashboard.mintlify.com/products/assistant/settings/billing) to control costs.
130+
131+
## Troubleshooting
132+
133+
<Accordion title="Discord bot not responding">
134+
If the Discord bot doesn't respond to questions:
135+
136+
- Verify the bot has permission to read and send messages in the channel.
137+
- Check that the channel is configured in your integration settings.
138+
- Ensure your message allowance hasn't been exceeded.
139+
- Try disconnecting and reconnecting the integration.
140+
</Accordion>
141+
142+
<Accordion title="Slack app not responding">
143+
If the Slack app doesn't respond to questions:
144+
145+
- Verify the app has permission to read and send messages in the channel.
146+
- Check that the channel is configured in your integration settings.
147+
- Ensure your message allowance hasn't been exceeded.
148+
- Try disconnecting and reconnecting the integration.
149+
</Accordion>
150+
151+
<Accordion title="Connection failed">
152+
If you encounter errors when connecting:
153+
154+
- Verify you have admin permissions on the platform.
155+
- Check that your Mintlify plan includes assistant integrations.
156+
- Try clearing your browser cache and reconnecting.
157+
- Contact [support](mailto:[email protected]) if the issue persists.
158+
</Accordion>
159+
160+
<Accordion title="Cannot find Integrations tab">
161+
If you don't see the Integrations tab:
162+
163+
- Verify your plan includes assistant integrations (Pro or Custom).
164+
- Check that you have the necessary permissions in your dashboard.
165+
- Contact [support](mailto:[email protected]) to enable the feature.
166+
</Accordion>

0 commit comments

Comments
 (0)