Documentation

Everything you need to get started with DevRelBot.

Introduction

DevRelBot is an AI-powered assistant designed specifically for Developer Relations teams. It helps you automate repetitive support tasks, provide instant answers to developer questions, and gain insights from community conversations.

With DevRelBot, you can transform your documentation, FAQs, GitHub issues, and Slack/Discord conversations into a searchable, responsive, and measurable support system.

Quick Start

Get up and running with DevRelBot in just a few minutes:

  1. Sign up for a DevRelBot account
  2. Connect your first integration (Slack, Discord, or GitHub)
  3. Import your documentation or knowledge base
  4. Configure your bot's personality and responses
  5. Start answering developer questions automatically!

Installation

DevRelBot is a cloud-based service, so there's no software to install. Simply sign up and connect your integrations through our dashboard.

For enterprise customers who require on-premise deployment, we offer a self-hosted option. Contact our sales team for more information.

Slack Integration

Connect DevRelBot to your Slack workspace to automatically answer developer questions in your community channels.

# Install the DevRelBot Slack app
1. Go to Settings > Integrations > Slack
2. Click "Add to Slack"
3. Authorize the app in your workspace
4. Select the channels to monitor

# Configuration options
- Auto-respond: Enable/disable automatic responses
- Channels: Select which channels to monitor
- Mention-only: Only respond when @mentioned
- Thread replies: Reply in threads vs. channel

Discord Integration

Add DevRelBot to your Discord server to provide 24/7 support to your developer community.

# Install the DevRelBot Discord bot
1. Go to Settings > Integrations > Discord
2. Click "Add to Discord"
3. Select your server and authorize
4. Configure channel permissions

# Bot commands
/devrel ask [question] - Ask a question
/devrel search [topic] - Search knowledge base
/devrel feedback - Submit feedback
/devrel help - Show available commands

GitHub Integration

Connect DevRelBot to your GitHub repositories to automatically respond to issues and discussions.

# Connect GitHub
1. Go to Settings > Integrations > GitHub
2. Click "Connect GitHub"
3. Install the GitHub App
4. Select repositories to monitor

# Features
- Auto-label issues based on content
- Suggest related issues/docs
- Auto-respond to common questions
- Track issue trends and patterns

Knowledge Base

Your knowledge base is the foundation of DevRelBot's intelligence. Import your existing documentation and let the AI learn from it.

# Supported sources
- Markdown files (.md)
- HTML documentation
- Notion pages
- GitBook
- Confluence
- Custom URLs

# Import methods
- Direct upload
- URL crawling
- API sync
- Git repository sync

Custom Responses

Customize how DevRelBot responds to different types of questions. Set up templates, tone preferences, and escalation rules.

# Response configuration
{
  "tone": "friendly",
  "include_sources": true,
  "max_length": 500,
  "escalation_threshold": 0.7,
  "fallback_message": "I'm not sure about that. Let me get a human to help you!"
}

Analytics

Track the performance of your DevRel efforts with comprehensive analytics and reporting.

Key metrics include:

  • Response time and resolution rate
  • Developer satisfaction scores
  • Most common questions and topics
  • Knowledge gaps and content suggestions
  • Team performance metrics

API Overview

The DevRelBot API allows you to integrate our AI capabilities into your own applications and workflows.

Base URL: https://api.devrelbot.tech/v1

# Available endpoints
GET  /conversations     - List conversations
POST /conversations     - Create conversation
GET  /knowledge         - Search knowledge base
POST /knowledge         - Add to knowledge base
GET  /analytics         - Get analytics data

Authentication

All API requests require authentication using an API key.

# Include your API key in the header
curl -X GET "https://api.devrelbot.tech/v1/conversations" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

API Endpoints

Detailed documentation for each API endpoint:

# Create a conversation
POST /v1/conversations
{
  "message": "How do I authenticate with the API?",
  "channel": "api",
  "user_id": "user_123"
}

# Response
{
  "id": "conv_abc123",
  "response": "To authenticate with the API...",
  "confidence": 0.95,
  "sources": ["docs/authentication.md"]
}