Slack Integration

Ragpi's Slack integration allows you to easily connect your technical documentation and knowledge base with your Slack workspace. By deploying a Slack bot powered by Ragpi, users can ask questions and receive AI-assisted answers directly within Slack channels.

Setup Guide

1. Create a Slack App

Go to the Slack Apps page and log in.
Click Create New App, then From a Manifest, then select your workspace and click Next.
Under the JSON tab, paste the following:

{
  "display_information": {
    "name": "Ragpi Bot",
    "description": "A helpful AI Assistant",
    "background_color": "#000000"
  },
  "features": {
    "bot_user": {
      "display_name": "Ragpi Bot",
      "always_online": true
    }
  },
  "oauth_config": {
    "scopes": {
      "bot": [
        "channels:history",
        "chat:write",
        "groups:history",
        "app_mentions:read"
      ]
    }
  },
  "settings": {
    "event_subscriptions": {
      "bot_events": ["app_mention", "message.channels", "message.groups"]
    },
    "interactivity": {
      "is_enabled": true
    },
    "org_deploy_enabled": false,
    "socket_mode_enabled": true,
    "token_rotation_enabled": false
  }
}

Click Create.

2. Configure the Bot

On the Basic Information page, under App-Level Tokens, click Generate Token and Scopes and create a new token with the connections:write scope.
- Important: Save this token securely, as it will be used later for the SLACK_APP_TOKEN environment variable.
Next, navigate to the OAuth & Permissions page and under OAuth Tokens, click Install to [YourWorkspace] and authorize the app.
- Important: Save the Bot User OAuth Token for the SLACK_BOT_TOKEN environment variable.

3. Deploy Ragpi with Slack Integration

Refer to the Deployment documentation to choose a deployment method and deploy Ragpi with the Slack integration.

Ensure that the following environment variables are configured when deploying the Slack integration:

SLACK_APP_TOKEN=your-app-token
SLACK_BOT_TOKEN=your-bot-token

4. Using the bot

After configuring the bot and deploying Ragpi, the bot will be available in your Slack workspace. You can invite it to the channels you want it to respond in by mentioning it in the desired channel. When asked a question, the bot will respond in a thread to keep conversations organized.

important

By default, the bot will reply to all messages in the channels it has been invited to. If you want to restrict the bot to only respond to messages that mention it, set the SLACK_REQUIRE_MENTION environment variable to true.

Configuration

Variable	Description	Default	Notes
`SLACK_BOT_TOKEN`	The slack bot token for authenticating with Slack	None	Required
`SLACK_APP_TOKEN`	The slack app token for authenticating with Slack	None	Required
`RAGPI_BASE_URL`	Base URL for Ragpi. All chat requests will be sent to this endpoint	None	Required
`RAGPI_API_KEY`	API key for authenticating with Ragpi endpoints	None	If provided, sets the `x-api-key` header on requests to Ragpi API.
`RAGPI_SOURCES`	Comma-separated list of sources to pass to Ragpi for context retrieval	None	If not set, will use all sources.
`SLACK_REQUIRE_MENTION`	Whether the bot requires a direct mention to respond	`false`	Accepts `true`, `True`, or `TRUE` for enabled; anything else is treated as disabled.

Setup Guide​

1. Create a Slack App​

2. Configure the Bot​

3. Deploy Ragpi with Slack Integration​

4. Using the bot​

Configuration​