diff --git a/changelog.mdx b/changelog.mdx index 95908f490..dabfce1e0 100644 --- a/changelog.mdx +++ b/changelog.mdx @@ -5,6 +5,20 @@ rss: true noindex: true --- + + +## Slack bot integration + +- **Major release**: Comprehensive Slack bot integration for the Writer Agent system +- Bot responds to direct messages (DMs) from users with proper event filtering +- Added OAuth scopes for full functionality: `im:read`, `im:write`, `im:history`, `channels:history`, `groups:history`, `mpim:history` +- Event subscriptions support: `message.im`, `message.channels`, `message.groups`, `message.mpim`, `app_mention` +- Real-time display of Slack bot status in dashboard +- Formatted display for pull request links and Writer Agent completion notifications +- Enhanced UI with proper Slack message formatting support (*bold text*, links, user mentions, channel references) + + + ## Language support expansion diff --git a/docs.json b/docs.json index 2f8762811..5a1b591a2 100644 --- a/docs.json +++ b/docs.json @@ -216,6 +216,7 @@ "icon": "messages-square", "pages": [ "integrations/support/overview", + "integrations/support/slack", "integrations/support/intercom", "integrations/support/front" ] @@ -483,6 +484,7 @@ "icon": "messages-square", "pages": [ "fr/integrations/support/overview", + "integrations/support/slack", "fr/integrations/support/intercom", "fr/integrations/support/front" ] @@ -750,6 +752,7 @@ "icon": "messages-square", "pages": [ "es/integrations/support/overview", + "integrations/support/slack", "es/integrations/support/intercom", "es/integrations/support/front" ] @@ -1017,6 +1020,7 @@ "icon": "messages-square", "pages": [ "zh/integrations/support/overview", + "integrations/support/slack", "zh/integrations/support/intercom", "zh/integrations/support/front" ] diff --git a/integrations/support/overview.mdx b/integrations/support/overview.mdx index 21892b0c1..12947ca55 100644 --- a/integrations/support/overview.mdx +++ b/integrations/support/overview.mdx @@ -4,6 +4,14 @@ description: "Integrate with a support widget" --- + + Integrate Writer Agent with Slack for automated documentation notifications + + The Slack integration is available for Writer Agent users and enables automated notifications when documentation updates are completed. + + +## About the Slack integration + +The Slack integration connects Mintlify's Writer Agent with your Slack workspace, providing real-time notifications when documentation updates are completed. The bot can send direct messages and post to channels, keeping your team informed about documentation changes. + +### Key features + +- **Direct message handling**: Receive notifications via direct messages from the Mintlify bot +- **Channel notifications**: Get updates posted to specific channels +- **Pull request links**: Automatically formatted links to completed documentation updates +- **Real-time status**: Live updates on Writer Agent completion status + +## Setting up the Slack integration + +### Prerequisites + +- Active Mintlify Writer Agent subscription +- Slack workspace admin permissions +- Access to your Slack app configuration + +### Required OAuth scopes + +Configure your Slack app with the following OAuth scopes for full functionality: + +#### Bot token scopes +- `im:read` - Read DM channel information +- `im:write` - Send DM responses +- `im:history` - **Critical:** Receive DM message events +- `channels:history` - Receive channel message events +- `groups:history` - Receive private channel events +- `mpim:history` - Receive group DM events + +### Event subscriptions + +Configure these bot event subscriptions in your Slack app settings: + +- `message.im` - Direct message events +- `message.channels` - Public channel messages +- `message.groups` - Private channel messages +- `message.mpim` - Group DM messages +- `app_mention` - When the bot is mentioned + +### Installation steps + +1. **Create a Slack app** in your workspace or use an existing one +2. **Configure OAuth scopes** as listed above in your app's OAuth & Permissions section +3. **Set up event subscriptions** in your app's Event Subscriptions section +4. **Install the app** to your workspace +5. **Configure the integration** in your Mintlify dashboard + +## Using the Slack integration + +### Notification types + +The Slack bot sends notifications for: + +- **Documentation updates completed**: When Writer Agent finishes updating your docs +- **Pull request creation**: Links to newly created pull requests with documentation changes +- **Status updates**: Real-time updates on Writer Agent processing status + +### Message formatting + +The bot uses standard Slack formatting: + +- **Bold text** using single asterisks (`*bold*`) +- **Links** formatted as `` +- **User mentions** as `<@USER_ID>` +- **Channel references** as `<#CHANNEL_ID>` + +### Dashboard integration + +The Mintlify dashboard displays: + +- Real-time Slack bot status +- Writer Agent completion notifications +- Formatted display for pull request links +- Message history and delivery status + +## Troubleshooting + +### Common issues + + + + Ensure the `im:history` scope is enabled - this is critical for receiving DM events. Check that event subscriptions are properly configured for `message.im`. + + + + Verify that the bot has been added to the target channel and has the appropriate `channels:history` or `groups:history` scope depending on channel type. + + + + The bot automatically handles Slack message formatting. If links or mentions aren't working, check that the message content follows Slack's formatting standards. + + + +### Support + +If you encounter issues with the Slack integration: + +1. Verify all required OAuth scopes are enabled +2. Check that event subscriptions are properly configured +3. Ensure the bot is installed and has necessary permissions +4. Contact [Mintlify support](mailto:support@mintlify.com) for additional assistance + +## Security considerations + +- The bot only processes messages and events it's explicitly subscribed to +- Bot messages are automatically filtered to prevent loops +- All communications use Slack's secure API endpoints +- No sensitive documentation content is stored in Slack messages \ No newline at end of file