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
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
"index",
"quickstart",
"installation",
"slack-integration",
{
"group": "Web editor",
"icon": "mouse-pointer-2",
Expand Down
163 changes: 163 additions & 0 deletions slack-integration.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
---
title: "Slack integration"
description: "Install and use Mintlify's Slack integration to get documentation updates and notifications"
icon: "slack"
---

Mintlify's Slack integration keeps your team informed about documentation updates, build statuses, and deployment notifications directly in your Slack workspace.

<Info>
**Prerequisites**: You need admin access to your Slack workspace and a Mintlify account with an active documentation project.

Check warning on line 10 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L10

': Y' should be in lowercase.

Check warning on line 10 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L10

Use 'administrator' instead of 'admin'.
</Info>

## Installing the Slack app

Check warning on line 13 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L13

'Installing the Slack app' should use sentence-style capitalization.

Follow these steps to install the Mintlify Slack app in your workspace:

<Steps>
<Step title="Access the Slack integration">
1. Navigate to your [Mintlify dashboard](https://dashboard.mintlify.com)
2. Go to **Settings** in the left sidebar
3. Select **Integrations** from the settings menu
4. Find the **Slack** integration card
</Step>

<Step title="Install the app">
1. Click **Install Slack App**
2. You'll be redirected to Slack's authorization page

Check warning on line 27 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L27

In general, use active voice instead of passive voice ('be redirected').
3. Select the workspace where you want to install the app
4. Review the permissions and click **Allow**
</Step>

<Step title="Configure channels">
After installation, you'll be redirected back to your Mintlify dashboard where you can:

Check warning on line 33 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L33

In general, use active voice instead of passive voice ('be redirected').
1. Select which channels should receive notifications
2. Choose the types of notifications you want to receive
3. Test the integration with a sample notification
</Step>
</Steps>

## Configuring notifications

The Slack integration supports several types of notifications:

### Build notifications
Get notified when your documentation builds start, succeed, or fail:

- **Build started**: Notification when a new build begins
- **Build succeeded**: Confirmation when builds complete successfully
- **Build failed**: Alerts when builds encounter errors with details

### Deployment notifications
Stay informed about your documentation deployments:

- **Deployment started**: When your docs begin deploying
- **Deployment completed**: Confirmation of successful deployments
- **Deployment failed**: Alerts for failed deployments with error details

### Content updates
Track changes to your documentation content:

- **New pages added**: Notifications when team members add new documentation pages
- **Pages updated**: Alerts when existing pages are modified

Check warning on line 62 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L62

In general, use active voice instead of passive voice ('are modified').
- **Pages deleted**: Notifications when pages are removed

Check warning on line 63 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L63

In general, use active voice instead of passive voice ('are removed').

## Using Slack commands

Check warning on line 65 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L65

'Using Slack commands' should use sentence-style capitalization.

Once installed, you can use these Slack commands to interact with your documentation:

### `/mintlify status`
Check the current status of your documentation builds and deployments.

```
/mintlify status
```

### `/mintlify deploy`
Trigger a manual deployment of your documentation (requires appropriate permissions).

Check warning on line 77 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L77

Use parentheses judiciously.

```
/mintlify deploy
```

### `/mintlify help`
Get a list of available commands and their usage.

```
/mintlify help
```

## Managing permissions

Control who can use Mintlify commands in your Slack workspace:

<Steps>
<Step title="Access app settings">
1. In Slack, go to **Settings & administration** > **Manage apps**
2. Find **Mintlify** in your installed apps
3. Click on the app to access its settings
</Step>

<Step title="Configure permissions">
1. Go to the **Permissions** tab
2. Set which users or user groups can:
- Trigger deployments
- View build status
- Receive notifications
3. Save your changes
</Step>
</Steps>

## Customizing notification channels

You can send different types of notifications to different channels:

1. **Development channel**: Build status and deployment notifications
2. **General team channel**: New page notifications and major updates
3. **Admin channel**: Error alerts and system notifications

To configure channel-specific notifications:

1. Go to your Mintlify dashboard **Settings** > **Integrations** > **Slack**
2. Click **Manage Channels**
3. For each notification type, select the appropriate channel
4. Save your configuration

## Troubleshooting

<AccordionGroup>
<Accordion title="Slack app not appearing in workspace">
**Solution**: Ensure you have admin permissions in your Slack workspace. If you're not an admin, ask a workspace admin to install the app or grant you the necessary permissions.

Check warning on line 130 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L130

': E' should be in lowercase.

Check warning on line 130 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L130

Use 'administrator' instead of 'admin'.

Check warning on line 130 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L130

Use 'administrator' instead of 'admin'.

Check warning on line 130 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L130

Use 'administrator' instead of 'admin'.
</Accordion>

<Accordion title="Not receiving notifications">
**Solution**:
1. Check that the Mintlify app has permission to post in your selected channels
2. Verify your notification settings in the Mintlify dashboard
3. Ensure the channels you selected still exist and the app is a member
</Accordion>

<Accordion title="Commands not working">
**Solution**:
1. Make sure you're using the correct command syntax
2. Verify you have the necessary permissions to use the command
3. Try reinstalling the app if commands consistently fail
</Accordion>

<Accordion title="Duplicate notifications">
**Solution**: Check if you have multiple notification rules set up for the same events. Remove duplicate configurations in your dashboard settings.

Check warning on line 148 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L148

': C' should be in lowercase.
</Accordion>
</AccordionGroup>

## Uninstalling the integration

If you need to remove the Slack integration:

1. In your Mintlify dashboard, go to **Settings** > **Integrations** > **Slack**
2. Click **Disconnect Slack**
3. Confirm the disconnection
4. Optionally, remove the app from your Slack workspace by going to **Settings & administration** > **Manage apps** > **Mintlify** > **Remove**

<Warning>
Uninstalling the integration will stop all notifications and disable Slack commands. This action cannot be undone, but you can reinstall the integration at any time.

Check warning on line 162 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L162

Avoid using 'will'.

Check warning on line 162 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L162

Use 'turn off' or 'off' instead of 'disable'.

Check warning on line 162 in slack-integration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

slack-integration.mdx#L162

Use 'can't' instead of 'cannot'.
</Warning>