diff --git a/fern/products/ask-fern/pages/assets/allow-slack.png b/fern/products/ask-fern/pages/assets/allow-slack.png new file mode 100644 index 00000000..07f30dfe Binary files /dev/null and b/fern/products/ask-fern/pages/assets/allow-slack.png differ diff --git a/fern/products/ask-fern/pages/assets/request-slack.png b/fern/products/ask-fern/pages/assets/request-slack.png new file mode 100644 index 00000000..27d68c91 Binary files /dev/null and b/fern/products/ask-fern/pages/assets/request-slack.png differ diff --git a/fern/products/ask-fern/pages/assets/respond-all-slack.png b/fern/products/ask-fern/pages/assets/respond-all-slack.png new file mode 100644 index 00000000..1b29f7e6 Binary files /dev/null and b/fern/products/ask-fern/pages/assets/respond-all-slack.png differ diff --git a/fern/products/ask-fern/pages/assets/update-name-slack.png b/fern/products/ask-fern/pages/assets/update-name-slack.png new file mode 100644 index 00000000..81c18b42 Binary files /dev/null and b/fern/products/ask-fern/pages/assets/update-name-slack.png differ diff --git a/fern/products/ask-fern/pages/features/slack-app.mdx b/fern/products/ask-fern/pages/features/slack-app.mdx index 5df63530..b8a54149 100644 --- a/fern/products/ask-fern/pages/features/slack-app.mdx +++ b/fern/products/ask-fern/pages/features/slack-app.mdx @@ -19,6 +19,10 @@ To install Ask Fern in your organization's Slack workspace, you must be a Slack 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** + + Allow Ask Fern for Slack workspace + + @@ -29,9 +33,15 @@ To give customers access to the Ask Fern bot in their own Slack workspaces: 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. + + + Respond all setting in Slack + 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. @@ -43,20 +53,33 @@ Customize the bot's behavior to match your workflow needs. -Use the `/configure` command in any channel to adjust the following settings: +Use the `/configure` slash command in any channel to adjust the settings: + +| Command | Description | Example | +|---------|-------------|---------| +| **respond_to** | Controls whether the Ask Fern bot responds to all messages (`all`) or only when directly mentioned with `@Ask Fern` (`mentions_only`) | `/configure respond_to all` | +| **roles** | Specifies which RBAC roles should be used to filter Ask Fern responses (if you have [role-based access control](/docs/authentication/rbac) configured) | `/configure roles developer, admin` | +| **show** | Show the current settings | `/configure show` | +| **help** | Get help with Ask Fern slash commands | `/configure help` | + + + Respond all setting in Slack + -- **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 +1. In Slack, go to **Apps** in the sidebar and click **Ask Fern** +1. Click the **About** tab, then **Configuration** +1. Scroll to **Bot User** section and click **Edit** +1. Enter your preferred bot name and save changes + + + + Update name of Slackbot + Now customers will see `@YourCompanyName Support was added to the channel` instead of the default `@Ask Fern` name.