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?Learn what ReplyRabbit does for FreeScout teams, including AI drafts, next actions, Linear handoffs, and human review.Why use AI?Plan why every freescout team should use ai with ReplyRabbit, FreeScout, reviewed drafts, clear policies, and human support ownership.FreeScout AI assistantLearn what a FreeScout AI assistant does in ReplyRabbit, including drafts, next actions, handoffs, and human review.
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. Pro adds 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. Pro adds 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. Pro adds 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.Custom AI endpointSet up ReplyRabbit with your own OpenAI-compatible chat endpoint, optional bearer token, and separate models for embeddings and vision.Install in 5 minutesInstall and set up ReplyRabbit for FreeScout with the practical checks admins need before generating reviewed AI drafts.First AI replyUse ReplyRabbit AI drafts to write clearer support replies while checking facts, tone, policy, and next steps before sending.OpenAI settingsConnect and tune an AI provider for ReplyRabbit in FreeScout, including API keys, model choice, testing, privacy, and budgets.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 and tune an AI provider for ReplyRabbit in FreeScout, including API keys, model choice, testing, privacy, and budgets.Connect ClaudeConnect and tune an AI provider for ReplyRabbit in FreeScout, including API keys, model choice, testing, privacy, and budgets.Connect GeminiConnect and tune an AI provider for ReplyRabbit in FreeScout, including API keys, model choice, testing, privacy, and budgets.Connect OllamaUse local AI models with ReplyRabbit and FreeScout while keeping draft review and operational checks in place.Connect OpenRouterConnect and tune an AI provider for ReplyRabbit in FreeScout, including API keys, model choice, testing, privacy, and budgets.Local AI modelsUse local AI models with ReplyRabbit and FreeScout while keeping draft review and operational checks in place.AI workflowsBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.Linear overviewUse ReplyRabbit and Linear together so FreeScout support conversations become reviewed engineering handoffs with context.Create Linear issuesUse ReplyRabbit and Linear together so FreeScout support conversations become reviewed engineering handoffs with context.Slack overviewUse ReplyRabbit Slack notifications with FreeScout and Linear handoffs while keeping support context safe and reviewable.FreeScout to SlackUse ReplyRabbit Slack notifications with FreeScout and Linear handoffs while keeping support context safe and reviewable.GitHub workflowsBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.Jira workflowsBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.Discord alertsBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.Support webhooksBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.
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.TroubleshootingFixes for common ReplyRabbit issues: no draft generated, provider errors, missing menu, issue tracker tickets, Workflow Tags, 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.Choose support modelsChoose AI models for customer support by testing accuracy, tone, cost, latency, privacy, and edit time in ReplyRabbit.AI privacyReview AI privacy and security choices for ReplyRabbit, FreeScout, cloud providers, local models, and customer data handling.Self-hosted AIReview AI privacy and security choices for ReplyRabbit, FreeScout, cloud providers, local models, and customer data handling.Better AI repliesUse ReplyRabbit AI drafts to write clearer support replies while checking facts, tone, policy, and next steps before sending.Angry customersUse ReplyRabbit AI drafts to write clearer support replies while checking facts, tone, policy, and next steps before sending.Refund responsesUse ReplyRabbit AI drafts to write clearer support replies while checking facts, tone, policy, and next steps before sending.Shipping delaysUse ReplyRabbit AI drafts to write clearer support replies while checking facts, tone, policy, and next steps before sending.Technical workflowsBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.Escalate with contextBuild AI-assisted FreeScout workflows with ReplyRabbit, reviewed context, careful handoffs, and approved external tools.Consistent AI toneUse ReplyRabbit AI drafts to write clearer support replies while checking facts, tone, policy, and next steps before sending.Draft quality checklistUse a practical support checklist for ReplyRabbit AI drafts so agents catch accuracy, tone, privacy, and policy issues.ReplyRabbit vs ChatGPTCompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.ReplyRabbit vs Zendesk AICompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.ReplyRabbit vs Help Scout AICompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.ReplyRabbit vs Freshdesk AICompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.ReplyRabbit vs Intercom AICompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.ReplyRabbit vs Gorgias AICompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.ReplyRabbit vs Front AICompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.AI browser extensionsCompare ReplyRabbit with another AI support option based on FreeScout fit, workflow control, privacy, migration effort, and review.Best support modelsChoose AI models for customer support by testing accuracy, tone, cost, latency, privacy, and edit time in ReplyRabbit.GPT vs Claude vs GeminiChoose AI models for customer support by testing accuracy, tone, cost, latency, privacy, and edit time in ReplyRabbit.Local LLMsUse local AI models with ReplyRabbit and FreeScout while keeping draft review and operational checks in place.Reduce hallucinationsUse a practical support checklist for ReplyRabbit AI drafts so agents catch accuracy, tone, privacy, and policy issues.Support promptsUse a practical support checklist for ReplyRabbit AI drafts so agents catch accuracy, tone, privacy, and policy issues.