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
93 changes: 93 additions & 0 deletions ai/slack-bot.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: "Slack bot"
description: "Get Writer Agent notifications and interact with your documentation directly in Slack"
icon: "slack"
---

The Slack bot integration enables direct messaging with the Writer Agent system and provides automated notifications for documentation updates. Users can receive real-time notifications about pull request completions and interact with the bot through direct messages.

## Features

### Direct message handling

The bot responds to direct messages from users and provides intelligent responses based on your documentation content. It filters out bot messages to prevent loops and uses type-safe message handling.

### Automated notifications

Receive notifications when the Writer Agent completes tasks, including:

- Pull request completion notifications
- Documentation update confirmations
- Formatted links to relevant pull requests

### Message formatting

The bot properly handles Slack-formatted messages including:

- **Bold text** using single asterisks
- Links formatted as `<url|display text>`
- User mentions as `<@USER_ID>`
- Channel references as `<#CHANNEL_ID>`

## Setting up the Slack bot

### Required OAuth scopes

Configure your Slack app with these OAuth scopes for full functionality:

Check warning on line 36 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L36

Use 'capability' or 'feature' instead of 'functionality'.

| Scope | Purpose |
|:------|:--------|
| `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

Check warning on line 55 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L55

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

### Bot configuration

1. Navigate to your Slack app settings
2. Add the required OAuth scopes listed above

Check warning on line 60 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L60

Use 'preceding' instead of 'above'.
3. Configure the event subscriptions
4. Install the bot to your workspace
5. Invite the bot to relevant channels where you want notifications

## Using the Slack bot

Check warning on line 65 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L65

'Using the Slack bot' should use sentence-style capitalization.

### Direct messaging

Send direct messages to the bot to:

- Ask questions about your documentation
- Request information about recent updates
- Get help with Writer Agent features

### Receiving notifications

The bot automatically sends notifications for:

- Completed Writer Agent tasks
- Documentation updates
- Pull request status changes

Notifications include formatted links and relevant context to help you stay informed about your documentation workflow.

## Dashboard integration

The Slack bot status and activity are displayed in your dashboard, showing:

Check warning on line 87 in ai/slack-bot.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/slack-bot.mdx#L87

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

- Real-time bot status
- Writer Agent completion notifications
- Message history and interaction logs

This integration helps you monitor bot activity and understand how your team interacts with the documentation through Slack.
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
"group": "AI optimization",
"pages": [
"guides/assistant",
"ai/slack-bot",
"ai/llmstxt",
"ai/contextual-menu",
"ai/model-context-protocol",
Expand Down