From 786d15f80f0914c24084b315666a1a240901757a Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Fri, 26 Sep 2025 20:06:48 -0400 Subject: [PATCH] add page on slack app --- fern/products/ask-fern/ask-fern.yml | 2 + .../ask-fern/pages/features/slack-app.mdx | 91 +++++++++++++++++++ 2 files changed, 93 insertions(+) create mode 100644 fern/products/ask-fern/pages/features/slack-app.mdx diff --git a/fern/products/ask-fern/ask-fern.yml b/fern/products/ask-fern/ask-fern.yml index dd3defdb3..7728a0efe 100644 --- a/fern/products/ask-fern/ask-fern.yml +++ b/fern/products/ask-fern/ask-fern.yml @@ -25,6 +25,8 @@ navigation: path: ./pages/features/insights.mdx - page: Evaluation path: ./pages/features/evals.mdx + - page: Slack app + path: ./pages/features/slack-app.mdx - api: API reference api-name: fai paginated: true diff --git a/fern/products/ask-fern/pages/features/slack-app.mdx b/fern/products/ask-fern/pages/features/slack-app.mdx new file mode 100644 index 000000000..5df635301 --- /dev/null +++ b/fern/products/ask-fern/pages/features/slack-app.mdx @@ -0,0 +1,91 @@ +--- +title: Ask Fern Slack app +description: Enable your customers to get instant answers to product questions directly in Slack using Ask Fern's AI-powered documentation bot. +--- + +The Ask Fern Slack app allows customers to ask questions about your products directly in Slack channels and receive AI-generated answers from your documentation database. + +Fern stores all questions and answers from Slack interactions for [analytics purposes](/ask-fern/features/analytics). + +## Setup + +Install the Ask Fern app and add the bot to customer channels. + + + + +To install Ask Fern in your organization's Slack workspace, you must be a Slack admin. Follow these steps: + +1. In your Fern dashboard, click the **Install to Slack** button. You'll be redirected to Slack to authorize the app +1. Select the workspace where you want to add Ask Fern and click **Allow** + + + + +To give customers access to the Ask Fern bot in their own Slack workspaces: + +1. Generate a customer installation link by making a request to: + ``` + https://fai.buildwithfern.com/slack/get-install?domain={your-domain} + ``` + This returns a unique URL that your customers can use to install Ask Fern to their own Slack workspace. +1. Forward this link to your customer so they can install the Ask Fern app to their workspace. +1. Once the customer has installed the Ask Fern app, you must add the bot to your customer Slack channel to give it access. + +Once added, customers will see that `@Ask Fern was added to the channel`. They can start asking questions immediately. + + + +## Configuration + +Customize the bot's behavior to match your workflow needs. + + + + +Use the `/configure` command in any channel to adjust the following settings: + +- **respond_to**: Controls whether the Ask Fern bot responds to all messages (`all`) or only when directly mentioned with `@Ask Fern` (`mentions_only`) +- **roles**: Specifies which RBAC roles should be used to filter Ask Fern responses (if you have [role-based access control](/docs/authentication/rbac) configured) + + + +You can rename the bot to match your brand (example: "YourCompanyName Support"): + +1. In Slack, go to **Apps** in the sidebar and click **Add Apps** +2. Search for **Ask Fern** and select it +3. Click the **About** tab, then **Configuration** +4. Scroll to **Bot User** section and click **Edit** +5. Enter your preferred bot name and save changes + +Now customers will see `@YourCompanyName Support was added to the channel` instead of the default `@Ask Fern` name. + + + +## Architecture + +When a user asks Ask Fern a question in Slack, a webhook triggers Fern's servers to search your documentation database and retrieve relevant context. Using that context, Ask Fern generates a response. + + + +```mermaid +sequenceDiagram + autonumber + participant U as User (Slack) + participant S as Slack Webhook + participant F as Fern Servers + participant V as Documentation Database + participant A as Ask Fern + + U->>S: Ask question to @Ask Fern + S->>F: Webhook fires to Fern servers + F->>F: Convert query to vector + F->>F: Check user roles (if RBAC enabled) + F->>V: Search for relevant chunks + V->>F: Return matching documents user can access + F->>A: Send query + context + A->>A: Generate response + A->>U: Return answer in Slack thread + F->>F: Store question and answer for analytics +``` + \ No newline at end of file