|
| 1 | +--- |
| 2 | +title: "Slack integration" |
| 3 | +description: "Get Writer Agent notifications and interact with your documentation through Slack" |
| 4 | +--- |
| 5 | + |
| 6 | +The Slack integration enables your team to receive Writer Agent notifications and interact with your documentation directly through Slack. This integration provides real-time updates when documentation changes are completed and allows for seamless communication about documentation updates. |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +### Writer Agent notifications |
| 11 | +Receive automatic notifications in Slack when the Writer Agent completes documentation tasks, including: |
| 12 | +- Pull request completion updates |
| 13 | +- Documentation generation status |
| 14 | +- Error notifications and status updates |
| 15 | + |
| 16 | +### Direct message support |
| 17 | +The Slack bot can respond to direct messages from team members, enabling: |
| 18 | +- Quick documentation queries |
| 19 | +- Status updates on ongoing tasks |
| 20 | +- Interactive communication with the Writer Agent system |
| 21 | + |
| 22 | +### Message formatting |
| 23 | +The integration properly handles Slack-specific formatting: |
| 24 | +- **Bold text** using single asterisks |
| 25 | +- Links formatted as `<url|display text>` |
| 26 | +- User mentions as `<@USER_ID>` |
| 27 | +- Channel references as `<#CHANNEL_ID>` |
| 28 | + |
| 29 | +## Setup |
| 30 | + |
| 31 | +### Prerequisites |
| 32 | +- A Slack workspace with admin permissions |
| 33 | +- Writer Agent enabled on your Mintlify account |
| 34 | +- Access to create Slack apps in your workspace |
| 35 | + |
| 36 | +### Slack app configuration |
| 37 | + |
| 38 | +1. Create a new Slack app in your workspace |
| 39 | +2. Configure the following OAuth scopes for your bot: |
| 40 | + |
| 41 | +#### Required scopes |
| 42 | +- `im:read` - Read DM channel information |
| 43 | +- `im:write` - Send DM responses |
| 44 | +- `im:history` - **Critical:** Receive DM message events |
| 45 | +- `channels:history` - Receive channel message events |
| 46 | +- `groups:history` - Receive private channel events |
| 47 | +- `mpim:history` - Receive group DM events |
| 48 | + |
| 49 | +### Event subscriptions |
| 50 | + |
| 51 | +Configure these bot event subscriptions in your Slack app settings: |
| 52 | + |
| 53 | +- `message.im` - Direct message events |
| 54 | +- `message.channels` - Public channel messages |
| 55 | +- `message.groups` - Private channel messages |
| 56 | +- `message.mpim` - Group DM messages |
| 57 | +- `app_mention` - When the bot is mentioned |
| 58 | + |
| 59 | +### Integration setup |
| 60 | + |
| 61 | +1. Navigate to your [Mintlify dashboard](https://dashboard.mintlify.com) |
| 62 | +2. Go to **Integrations** → **Support** |
| 63 | +3. Select **Slack** from the available integrations |
| 64 | +4. Provide your Slack app credentials: |
| 65 | + - Bot token |
| 66 | + - Signing secret |
| 67 | + - App ID |
| 68 | + |
| 69 | +## Usage |
| 70 | + |
| 71 | +### Receiving notifications |
| 72 | + |
| 73 | +Once configured, your team will automatically receive Slack notifications when: |
| 74 | +- Writer Agent completes documentation updates |
| 75 | +- Pull requests are processed |
| 76 | +- Documentation generation tasks finish |
| 77 | +- Errors occur during documentation processing |
| 78 | + |
| 79 | +### Direct messaging |
| 80 | + |
| 81 | +Team members can send direct messages to the bot for: |
| 82 | +- Checking the status of documentation tasks |
| 83 | +- Getting updates on specific pull requests |
| 84 | +- Receiving help with documentation-related queries |
| 85 | + |
| 86 | +### Channel integration |
| 87 | + |
| 88 | +The bot can be added to channels to: |
| 89 | +- Provide team-wide notifications |
| 90 | +- Respond to mentions and questions |
| 91 | +- Share documentation updates with relevant teams |
| 92 | + |
| 93 | +## Troubleshooting |
| 94 | + |
| 95 | +### Bot not responding to messages |
| 96 | +- Verify all required OAuth scopes are enabled |
| 97 | +- Check that event subscriptions are properly configured |
| 98 | +- Ensure the bot token has the necessary permissions |
| 99 | + |
| 100 | +### Missing notifications |
| 101 | +- Confirm the integration is enabled in your Mintlify dashboard |
| 102 | +- Verify the Slack app is installed in your workspace |
| 103 | +- Check that the bot has access to the relevant channels |
| 104 | + |
| 105 | +### Formatting issues |
| 106 | +- The bot automatically handles Slack formatting |
| 107 | +- Links and mentions are processed according to Slack's formatting standards |
| 108 | +- If formatting appears incorrect, verify your Slack app configuration |
| 109 | + |
| 110 | +## Support |
| 111 | + |
| 112 | +For additional help with the Slack integration: |
| 113 | +- Check your [Mintlify dashboard](https://dashboard.mintlify.com) for integration status |
| 114 | +- Review your Slack app configuration and permissions |
| 115 | +- Contact [Mintlify support ](mailto:[email protected]) for technical assistance |
0 commit comments