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

Check warning on line 3 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L3

'Connect Discord' should use sentence-style capitalization.
keywords: ["Discord integration", "Slack integration", "AI assistant", "community support", "chat integration"]
---

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

## About assistant integrations

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.

Check warning on line 13 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L13

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

When users ask questions in connected channels, the assistant:

* **Searches your documentation** to find relevant information and provide accurate answers.
* **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 embedded assistant.

## Access integrations

Manage your assistant integrations from the dashboard:

1. Navigate to your [dashboard](https://dashboard.mintlify.com).
2. Select **Assistant** from the products menu.
3. Click the **Integrations** tab.

<Frame>
<img src="/images/assistant/integrations-tab-light.png" alt="The assistant integrations tab in the dashboard." className="block dark:hidden" />
<img src="/images/assistant/integrations-tab-dark.png" alt="The assistant integrations tab in the dashboard." 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 Mintlify Assistant bot in your channels.

### Prerequisites

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

### Connect your server

1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations) in your dashboard.
2. Find **Discord** in the integrations list.
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 bot is added to your Discord server. You'll see a success message and Discord will appear in the **Connected apps** section.

Check warning on line 56 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L56

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

Check warning on line 56 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L56

Avoid using 'will'.

### Configure Discord channels

Check warning on line 58 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L58

'Configure Discord channels' should use sentence-style capitalization.

After connecting your server, configure which channels the assistant can access:

1. In the integrations list, click **Configure** next to Discord.
2. Select the channels where you want the assistant to respond to questions.
3. Save your configuration.

The assistant monitors selected channels and responds when users ask questions about your documentation.

## Connect Slack

Check warning on line 68 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L68

'Connect Slack' should use sentence-style capitalization.

Connect your Slack workspace to enable the Mintlify Assistant in your channels.

### Prerequisites

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

### Connect your workspace

1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations) in your dashboard.
2. Find **Slack** in the integrations list.
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 added to your Slack workspace. You'll see a success message and Slack will appear in the **Connected apps** section.

Check warning on line 86 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L86

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

Check warning on line 86 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L86

Avoid using 'will'.

### Configure Slack channels

Check warning on line 88 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L88

'Configure Slack channels' should use sentence-style capitalization.

After connecting your workspace, configure which channels the assistant can access:

1. In the integrations list, click **Configure** next to Slack.
2. Select the channels where you want the assistant to respond to questions.
3. Save your configuration.

The assistant monitors selected channels and responds when users ask questions about your documentation.

## Manage integrations

### View connection status

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.

### Disconnect an integration

To disconnect Discord or Slack:

1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations).
2. Find the integration in the **Connected apps** section.
3. Click **Configure**.
4. Click **Disconnect** and confirm.

The assistant stops responding in the disconnected platform's channels.

### Reconfigure channels

Update which channels the assistant monitors:

1. Navigate to the [Integrations tab](https://dashboard.mintlify.com/products/assistant/settings/integrations).
2. Find the integration in the **Connected apps** section.
3. Click **Configure**.
4. Update your channel selections.
5. Save your changes.

## Usage and billing

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

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.

## Troubleshooting

<Accordion title="Discord bot not responding">
If the Discord bot doesn't respond to questions:

- Verify the bot has permission to read and send messages in the channel.
- Check that the channel is configured in your integration settings.

Check warning on line 137 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L137

In general, use active voice instead of passive voice ('is configured').
- Ensure your message allowance hasn't been exceeded.

Check warning on line 138 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L138

In general, use active voice instead of passive voice ('been exceeded').
- Try disconnecting and reconnecting the integration.
</Accordion>

<Accordion title="Slack app not responding">
If the Slack app doesn't respond to questions:

- Verify the app has permission to read and send messages in the channel.
- Check that the channel is configured in your integration settings.

Check warning on line 146 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L146

In general, use active voice instead of passive voice ('is configured').
- Ensure your message allowance hasn't been exceeded.

Check warning on line 147 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L147

In general, use active voice instead of passive voice ('been exceeded').
- Try disconnecting and reconnecting the integration.
</Accordion>

<Accordion title="Connection failed">
If you encounter errors when connecting:

- Verify you have admin permissions on the platform.

Check warning on line 154 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L154

Use 'administrator' instead of 'admin'.
- Check that your Mintlify plan includes assistant integrations.
- Try clearing your browser cache and reconnecting.
- Contact [support](mailto:[email protected]) if the issue persists.
</Accordion>

<Accordion title="Cannot find Integrations tab">
If you don't see the Integrations tab:

- Verify your plan includes assistant integrations (Pro or Custom).

Check warning on line 163 in ai/assistant-integrations.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant-integrations.mdx#L163

Use parentheses judiciously.
- Check that you have the necessary permissions in your dashboard.
- Contact [support](mailto:[email protected]) to enable the feature.
</Accordion>
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,7 @@
"group": "AI",
"pages": [
"ai/assistant",
"ai/assistant-integrations",
"ai/agent",
"ai/autopilot",
"ai/llmstxt",
Expand Down
Loading