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
155 changes: 155 additions & 0 deletions ai/assistant-integrations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
---
title: "Assistant integrations"
description: "Connect Discord and Slack to bring your AI assistant to your community channels."
keywords: ["Discord", "Slack", "integrations", "chat", "community"]
---

<Info>
Assistant integrations are available on [Pro and Custom plans](https://mintlify.com/pricing?ref=assistant).
</Info>

## About assistant integrations

Assistant integrations extend your Mintlify Assistant beyond your documentation site to answer questions in your Discord servers and Slack workspaces. The assistant uses the same AI-powered search and response capabilities to help users find answers directly in the channels where they collaborate.

When connected, the assistant:

* **Answers questions** in Discord and Slack channels using your documentation as the knowledge base.
* **Cites sources** with links back to your documentation pages.
* **Generates code examples** to help users implement solutions.

Each message sent to the assistant in Discord or Slack counts toward your plan's message allowance, just like messages from your documentation site.

## Access integrations

Manage your assistant integrations from the dashboard:

1. Navigate to your [dashboard](https://dashboard.mintlify.com).
2. Select your documentation site.
3. Click **Products** > **Assistant** > **Settings**.
4. Click the **Integrations** tab.

<Frame>
<img src="/images/assistant/integrations-tab-light.png" alt="The Integrations tab in the Assistant settings." className="block dark:hidden" />
<img src="/images/assistant/integrations-tab-dark.png" alt="The Integrations tab in the Assistant settings." className="hidden dark:block" />
</Frame>

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.

## Connect Discord

Connect your Discord server to enable the assistant to answer questions in your Discord channels.

### Prerequisites

- Admin permissions in your Discord server.
- An active Mintlify Pro or Custom plan.

### Connect your server

1. Navigate to the **Integrations** tab in your assistant settings.
2. Find **Discord** in the list of available integrations.
3. Click **Connect**.
4. Sign in to Discord if prompted.
5. Select the server where you want to add the assistant.
6. Review the permissions and click **Authorize**.

The assistant is now connected to your Discord server. You'll see a success message and Discord will move to the **Connected apps** section.

### Use the assistant in Discord

Once connected, users can interact with the assistant in your Discord server:

- **Mention the bot** in any channel where it has access: `@MintlifyAssistant How do I set up authentication?`
- **Direct message** the bot for private conversations.

The assistant responds with answers from your documentation, including source citations and code examples when relevant.

### Manage your connection

After connecting Discord, you can configure which channels the assistant can access and manage other settings:

1. Navigate to the **Integrations** tab in your assistant settings.
2. Find **Discord** in the **Connected apps** section.
3. Click **Configure** to manage your Discord integration settings.

## Connect Slack

Connect your Slack workspace to enable the assistant to answer questions in your Slack channels.

### Prerequisites

- Admin permissions in your Slack workspace.
- An active Mintlify Pro or Custom plan.

### Connect your workspace

1. Navigate to the **Integrations** tab in your assistant settings.
2. Find **Slack** in the list of available integrations.
3. Click **Connect**.
4. Sign in to Slack if prompted.
5. Select the workspace where you want to add the assistant.
6. Review the permissions and click **Allow**.

The assistant is now connected to your Slack workspace. You'll see a success message and Slack will move to the **Connected apps** section.

### Use the assistant in Slack

Once connected, users can interact with the assistant in your Slack workspace:

- **Mention the bot** in any channel where it has access: `@Mintlify Assistant How do I set up authentication?`
- **Direct message** the bot for private conversations.

The assistant responds with answers from your documentation, including source citations and code examples when relevant.

### Manage your connection

After connecting Slack, you can configure which channels the assistant can access and manage other settings:

1. Navigate to the **Integrations** tab in your assistant settings.
2. Find **Slack** in the **Connected apps** section.
3. Click **Configure** to manage your Slack integration settings.

## Disconnect integrations

To disconnect an integration:

1. Navigate to the **Integrations** tab in your assistant settings.
2. Find the integration in the **Connected apps** section.
3. Click **Configure**.
4. Click **Disconnect** and confirm your choice.

The integration is removed and the assistant will no longer respond to questions in that platform.

## Troubleshooting

<Accordion title="Connection failed">
If you see an error when connecting Discord or Slack:

- Verify you have admin permissions in the Discord server or Slack workspace.
- Check that your Mintlify plan includes assistant integrations.
- Try disconnecting and reconnecting the integration.
- Clear your browser cache and try again.

If the issue persists, [contact support](mailto:support@mintlify.com).
</Accordion>

<Accordion title="Assistant not responding">
If the assistant doesn't respond to questions in Discord or Slack:

- Verify the integration shows as connected in your dashboard.
- Check that the assistant is enabled in your [assistant settings](/ai/assistant#enable-or-disable-the-assistant).
- Ensure you haven't reached your message allowance or spend limit.
- Verify the bot has access to the channel where you're asking questions.

If the issue persists, [contact support](mailto:support@mintlify.com).
</Accordion>

<Accordion title="Managing message usage">
Messages sent to the assistant in Discord and Slack count toward your plan's message allowance. To manage usage:

- Set a [spend limit](/ai/assistant#set-a-spend-limit) to control costs.
- Monitor usage in your [dashboard](https://dashboard.mintlify.com/products/assistant).
- Configure which channels the bot can access to limit usage.
- Consider upgrading your plan if you consistently reach your message allowance.
</Accordion>
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@
"icon": "wrench",
"pages": [
"ai/assistant",
"ai/assistant-integrations",
"ai/contextual-menu",
{
"group": "Insights",
Expand Down
Loading