ReplyRabbit Documentation
ReplyRabbit is the AI draft-reply module for the FreeScout help desk. These guides walk you through installing it, connecting an AI provider, and getting your first draft reply.
Start here
Getting startedInstall ReplyRabbit, connect an AI provider, and generate your first draft reply in FreeScout in about ten minutes.What is FreeScout?FreeScout is a free, self-hosted, open-source help desk and shared-inbox platform. Here is what it does and who it is for.What is ReplyRabbit?ReplyRabbit is a FreeScout module that drafts customer replies with AI for agents to review and send, adds next actions, and files bugs as tracker issues.Why use AI?Why FreeScout teams should use AI: a reviewed draft on every ticket cuts typing without giving up control, and ReplyRabbit adds it to FreeScout in minutes.FreeScout AI assistantA FreeScout AI assistant drafts replies in the conversation, suggests next actions and flags what needs attention. What it does for an agent, ticket by ticket.
Install & setup
Install FreeScoutA step-by-step overview of installing the self-hosted FreeScout help desk, with links to the official requirements and installer.Install ReplyRabbitInstall the ReplyRabbit module in FreeScout: download the right build for your licence, add it to your Modules folder, activate it in the admin, and clear the cache.Free vs paid buildsReplyRabbit ships two module builds. See what the free build includes, which features only exist in the paid build, and how to upgrade without losing settings.Set up ReplyRabbitConfigure your AI provider and API key, mailbox settings, company context, AI Signals, Workflow Tags, issue tracker, and optional Slack notifications.Linear integrationConnect ReplyRabbit to Linear so FreeScout support conversations can become structured engineering issues with context and status.GitHub Issues integrationConnect ReplyRabbit to GitHub Issues so FreeScout conversations can become linked issues with repository routing, labels, assignees, and status follow-up.Anthropic integrationConnect Anthropic to ReplyRabbit for FreeScout with your own API key, model selection, prompt caching behavior, token budget, and troubleshooting.Workflows integrationConfigure ReplyRabbit Workflow Tags so AI signals, draft state, no-reply decisions, and Linear links become FreeScout tags for workflow recipes.Jira integrationConnect ReplyRabbit to Jira Cloud so FreeScout conversations can become structured Jira issues with status sync and follow-up drafts.OpenAI integrationConnect OpenAI to ReplyRabbit for FreeScout draft generation with your own API key, model selection, prompt cache routing, token budgets, licensed semantic retrieval notes, and troubleshooting.Slack integrationSet up ReplyRabbit Slack notifications for FreeScout with an incoming webhook, test message, issue tracker alerts, and safe troubleshooting.Gemini integrationConnect Google AI Studio and Gemini models to ReplyRabbit for FreeScout with your own API key, model choice, cache token reporting, and setup checks.Ollama integrationConfigure Ollama as a local ReplyRabbit AI provider for FreeScout with localhost setup, model selection, testing, and troubleshooting.MCP clientsEnable the ReplyRabbit MCP endpoint, create a scoped bearer token, and connect approved MCP clients to safe FreeScout support context.OpenRouter integrationConnect OpenRouter to ReplyRabbit for FreeScout with your own API key, auto-router or model ID, cache reporting behavior, setup checks, and troubleshooting.WooCommerce connectorConnect WooCommerce to FreeScout with REST API keys so conversations show matched customer orders and purchase context, including full order history, line items, financials, and AI product-ownership.Magento connectorConnect Magento 2 or Adobe Commerce to FreeScout so conversations show matched customer orders and purchase context, including full order history, line items, financials, and AI product-ownership.Shopify connectorConnect Shopify to FreeScout with a custom app access token so conversations show matched customer orders and purchase context, including full order history, line items, financials, and AI product-ownership.Stripe ConnectorConnect Stripe to FreeScout with a restricted read-only API key and see recent customer payment details beside each support conversation.Semantic SearchInstall and set up the Semantic Search module for FreeScout. Multi-word searches work out of the box, and with your own OpenAI, Gemini, or compatible key it finds conversations by meaning and shows similar conversations in the sidebar.Connect FreeScout KBTurn on the FreeScout Knowledge Base source so ReplyRabbit drafts use your own help articles and link customers to the one that answers their question.Connect Outline KBConnect your Outline wiki to ReplyRabbit so drafts can draw on your team's knowledge base without sharing it with customers.Custom AI endpointSet up ReplyRabbit with your own OpenAI-compatible chat endpoint, optional bearer token, and separate models for embeddings and vision.Upgrade to PHP 8.5A checklist for moving a self-hosted FreeScout help desk to PHP 8.5, including why deprecation notices break FreeScout modules and how to check extensions, workers, and logs.Install in 5 minutesInstall ReplyRabbit in 5 minutes: download the build for your plan, unzip into FreeScout's Modules, activate, clear the cache, add a key, and draft a reply.First AI replyGenerate your first AI reply in FreeScout: install ReplyRabbit, add an OpenAI key and company context, open a customer email, then edit and send the draft.OpenAI settingsThe OpenAI settings that matter most in ReplyRabbit: model choice, company context and response style, examples, token budget, per-task models, and Auto Draft.Opportunity SuggestionsWeave relevant offering suggestions into drafts at natural sales moments like cancellations and pre-sales questions, with strict guardrails to protect tone and accuracy.Connect OpenAIConnect FreeScout to OpenAI in ReplyRabbit: pick OpenAI as the mailbox provider, paste your API key, choose a model, set a token budget, and draft a test reply.Connect ClaudeConnect FreeScout to Anthropic Claude through ReplyRabbit Pro: select Anthropic, paste your API key, pick a Claude model, and let prompt caching run itself.Connect GeminiConnect FreeScout to Google Gemini via ReplyRabbit's Google AI Studio provider: paste your AI Studio key, choose a Gemini model, and test a draft on a mailbox.Connect OllamaConnect FreeScout to Ollama so ReplyRabbit drafts on your own hardware: run Ollama on localhost:11434, pull a model, pick Ollama (Local), and test a draft.Connect OpenRouterConnect FreeScout to OpenRouter in ReplyRabbit Pro to reach many model vendors with one key: paste it, pick auto-router or a model ID, and test drafts.Local AI modelsUse local AI models with FreeScout by pointing a ReplyRabbit mailbox at Ollama or LM Studio on your server. Setup steps, hardware notes, and a rollout plan.AI workflowsAutomate FreeScout workflows with AI: Auto Draft, AI Signals, Workflow Tags that FreeScout Workflows recipes react to, and automatic issue creation on Team.Linear overviewHow the ReplyRabbit Linear integration works: an API key per mailbox, AI-written issues with routing, live status in FreeScout, and a follow-up draft when done.Create Linear issuesCreate Linear issues from FreeScout conversations in one click with ReplyRabbit: what the generated issue contains, how to review it, and the done loop.Slack overviewHow the ReplyRabbit Slack integration works: one incoming webhook per mailbox, a test button, and posts when an issue is created or a follow-up draft is ready.FreeScout to SlackSend support updates from FreeScout to Slack with ReplyRabbit: create an incoming webhook, paste it into the mailbox, test it, and get posts on new issues.GitHub workflowsConnect ReplyRabbit to GitHub Issues so a FreeScout bug report becomes a developer-ready issue in the right repo, with labels, routing and a follow-up draft.Jira workflowsConnect ReplyRabbit to Jira Cloud so FreeScout bug reports become Jira issues with the right project, type and priority, plus a follow-up draft when Done.Discord alertsReplyRabbit has no Discord integration. Built-in alerts go to Slack; for Discord, use Workflow Tags with FreeScout Workflows or a Slack channel you watch.Support webhooksReplyRabbit has no generic outbound webhook. It posts to a Slack webhook and exposes AI decisions as FreeScout tags for Workflows. How to build on that.
Reference
Choosing a providerCompare cloud, local, and custom OpenAI-compatible AI providers for ReplyRabbit, including privacy, model setup, and prompt caching.FAQAnswers to common questions about ReplyRabbit: data privacy, costs, prompt caching, supported models, local AI, Workflow Tags, and how drafts are generated.Built-in AIHow ReplyRabbit's built-in AI works on Pro and Team, its monthly fair-use allowance, what happens when it runs out, how to switch to your own key, and how support content is handled.TroubleshootingFixes for common ReplyRabbit issues: no draft generated, provider errors, errors after a PHP upgrade, missing menu, issue tracker tickets, Workflow Tags, knowledge sources, FreeScout cache, and prompt caching.Per-task AI modelsPick a separate provider, model, and API key for drafts, embeddings, mailbox previews, and attachment vision so routine tasks run on a cheaper model.PHP 8.5 errorsAfter upgrading to PHP 8.5, FreeScout modules can fail with "Function curl_close() is deprecated since 8.5". Find the module in the log, update it, and restart workers.Learning from past repliesWhat ReplyRabbit reads before it drafts a reply, how many past replies it searches per customer, how it learns your style, and what it doesn't use.Answers to other customersLet ReplyRabbit check each draft against answers your team already sent to other customers. How to turn it on step by step, what's stored, and what never carries over.Choose support modelsA decision guide for choosing an AI model for customer support: match the model to the task, mailbox and privacy rules, then confirm on real tickets.AI privacyAI privacy and security for self-hosted support: what ReplyRabbit sends to a provider, how local models keep email on your server, and the controls to set.Self-hosted AISelf-hosted AI customer support with ReplyRabbit: FreeScout on your server, your own AI provider key, and optional local models so nothing leaves your network.Better AI repliesWrite better customer support replies with AI by giving it your context, letting it draft, then editing for facts and tone. Before-and-after examples included.Angry customersHandle angry customers with AI draft replies that name the problem, fix what you can, and avoid defensiveness. A worked example and the edits to make first.Refund responsesWrite refund responses with ReplyRabbit that state the decision, amount and timeline in plain words. Examples for approved, partial and declined refunds.Shipping delaysWrite shipping delay responses with AI that give the real status, a date the customer can plan around, and a choice. Example draft and pre-send checks.Technical workflowsTechnical support workflows for FreeScout with ReplyRabbit: triage bug reports, read screenshots, draft precise replies, and hand real bugs to engineering.Escalate with contextEscalate support tickets without losing context: hand engineering a written summary, not a forwarded thread, and track follow-ups with Next Actions.Consistent AI toneKeep AI support tone consistent across agents and mailboxes by writing a response style once, adding real examples, and letting ReplyRabbit learn from edits.Draft quality checklistA support reply quality checklist for AI drafts: quick checks on accuracy, commitments, tone, structure and recipients to run before sending any reply.ReplyRabbit vs ChatGPTUsing ChatGPT for support means copying tickets in and answers out. ReplyRabbit drafts inside FreeScout with your context, policies and orders. Compare both.ReplyRabbit vs Zendesk AIReplyRabbit adds reviewed AI drafts to the FreeScout you already run. Zendesk AI comes with a hosted help desk platform. Compare fit, control and cost.ReplyRabbit vs Help Scout AIHelp Scout's AI comes with its hosted help desk. ReplyRabbit adds reviewed AI drafts in 17 languages to FreeScout, the self-hosted alternative. Compare the two.ReplyRabbit vs Freshdesk AIFreshdesk bundles AI into a hosted help desk you'd migrate to. ReplyRabbit brings reviewed AI drafts into FreeScout on your own server. Which suits your team?ReplyRabbit vs Intercom AIIntercom AI is a customer-facing agent inside a hosted messaging platform. ReplyRabbit drafts email replies for humans to send inside FreeScout. See which fits.ReplyRabbit vs Gorgias AIGorgias is a hosted ecommerce help desk with AI. ReplyRabbit gives FreeScout stores reviewed AI drafts that know each customer's orders via store connectors.ReplyRabbit vs Front AIFront is a hosted shared inbox with AI built in. ReplyRabbit adds reviewed AI drafts and smart reply routing to FreeScout. Compare workflow, privacy and cost.AI browser extensionsAI browser extensions draft replies on each agent's machine by reading the page. ReplyRabbit runs inside FreeScout on your server with shared context. Compare.Best support modelsThere's no single best AI model for customer support. Test candidates on your own tickets for edit time, accuracy, tone, cost and privacy in ReplyRabbit.GPT vs Claude vs GeminiGPT, Claude and Gemini all draft good support replies. Compare OpenAI, Anthropic and Google models on tone, cost, caching and embeddings in ReplyRabbit.Local LLMsLocal LLMs let support teams draft replies without sending customer email to a cloud AI. What they do well, where they fall short, and how to run one.Reduce hallucinationsReduce AI hallucinations in support replies by grounding drafts in your policies and help articles, adding order data, and checking specifics before sending.Support promptsPrompt engineering for support emails without writing prompts: put context, rules and examples in mailbox settings once and every ReplyRabbit draft uses them.AI confidence scoringAI confidence scoring shows agents how sure the AI was about a draft, so they know which replies need a slower check. How it works on the Team plan.Review before sendingAI support replies need human review because fluent drafts can be wrong on facts, policy and tone. Why ReplyRabbit never sends on its own, and what to check.GDPR and AI supportGDPR considerations for AI customer support: what processing you do, who the processor is, how to minimise data, keep human oversight and log AI actions.Self-hosted AI trendsAI customer support trends for self-hosted teams: agent-assist over bots, local models, bring-your-own provider, tag-based automation, and audit trails.AI-first support teamBuild an AI-first support team in FreeScout: a draft on every ticket, one written voice, measured edits, routing on signals, and humans on every send.