From 279c51abc01cc3f3d8ce4153aad9119d6915c57d Mon Sep 17 00:00:00 2001 From: Shannon Anahata Date: Wed, 15 Oct 2025 14:59:38 -0700 Subject: [PATCH 1/2] Updating feedback basics to be clearer --- .../sentry-basics/user-feedback-basics.mdx | 161 +++++++++++++----- 1 file changed, 120 insertions(+), 41 deletions(-) diff --git a/docs/product/sentry-basics/user-feedback-basics.mdx b/docs/product/sentry-basics/user-feedback-basics.mdx index 7c870d41cf968..6a9a650f13c73 100644 --- a/docs/product/sentry-basics/user-feedback-basics.mdx +++ b/docs/product/sentry-basics/user-feedback-basics.mdx @@ -6,21 +6,115 @@ description: "Learn how to configure and deploy Sentry's User Feedback widget to Sentry's [User Feedback Widget](/product/user-feedback/) is a powerful tool for capturing qualitative insights from real users, and is especially valuable during the rollout of new or beta features. Alternatively, it can be used to collect feedback from your fellow team members during an internal release. -Treat user feedback as a core signal in product development, especially for betas and early adopter programs. We recommend you integrate feedback review into planning, stand-ups, or retros; then you can use feedback trends to inform product direction and roadmap decisions. +If you treat user feedback as a core signal in product development, especially for betas and early adopter programs, your final product will be better. We recommend adding feedback reviews into planning, stand-ups, or retros; then you can use feedback trends to inform product direction and roadmap decisions. -This 4-step guide will walk you through implementing and instrumenting User Feedback on your application. +This 4-step guide will walk you through implementing and instrumenting User Feedback for your application. ## 1. Embed the Widget Contextually -Bring the widget to the user; don't make them go find it. +Bring the widget to the user; instead of making them find it. Embed the feedback widget directly into experimental or high-impact feature areas. For example, on your checkout screen: -![](feedback-img/img/feedback-on-checkout-page.png) +![Feedback widget on checkout page =650x](feedback-img/img/feedback-on-checkout-page.png) + +### Basic Implementation + +Before implementing, make sure you've set up the User Feedback integration for your platform. See the [User Feedback setup documentation](/product/user-feedback/setup/) for platform-specific installation instructions. + +Here's a simple example of how to open the feedback form with a button click. This example shows a React implementation. The specific code will vary based on your platform. + +**Javascript Example: Simple Feedback Button** + +```javascript +import * as Sentry from "@sentry/react"; + +function FeedbackButton() { + const feedback = Sentry.getFeedback(); + + if (!feedback) { + return null; + } + + return ( + + ); +} +``` + +## 2. Customize Placeholder Text +Personalized prompts lead to better feedback. Tailor the placeholder text to the feature's context. + +You can customize the text prompt shown to users in the feedback form. The configuration option varies by platform. It's commonly `messagePlaceholder` for frontend SDKs or `labelComments` for backend crash-report modals. + +
+**JavaScript Example** + +```javascript +const form = await feedback.createForm({ + messagePlaceholder: 'How was your experience with checkout?', +}); +``` + +
+ +Here are examples of placeholder text to guide users: + +> How was your experience with [your feature's name]? + +> How can we make your experience better? + +> We're still building out [your feature's name] - how can we make it better? + +It's best to customize your prompts for clarity and relevance; this will guide the user to provide useful input. Use friendly language to encourage honest, casual feedback. + + +## 3. Add Custom Tags to Feedback Submissions For Better Routing + +If you have multiple feedback buttons in your application that are embedded into different features, tags are critical in order to enable faster alert routing and triaging for the right teams. + +You can auto-apply tags based on the widget’s placement. For example, use a custom tag like `feedback.source:checkout`. This allows for routing in Slack and filtering in dashboards. We recommend you define and standardize tags using a single key, such as `feedback.source`. + + +## 4. Set Up Alerts to Relevant Channels +Feedback is only useful if seen by the right folks. + +You can send User Feedback directly into the appropriate team’s channel—whether you use Slack, Microsoft Teams, or Discord (see [complete list of integrations](/product/alerts/create-alerts/routing-alerts/#integrations)). For example, you can tag feedback `feedback.source:checkout` and always have it go to your `#proj-billing` channel in Slack. With this workflow, engineers see feedback in near-real time and take ownership. + +Follow the steps below to set up feedback alerts to relevant channels: + +1. Create a [New Alert Rule](https://sentry.io/alerts/new/issue/) in Sentry. +2. Scroll to the "Set conditions" section and set the "IF" filter to `The issue's category is equal to… "Feedback"` and `The event's tags match... [your custom tag]`. +3. In the “THEN” filter, select `Send a [your integration] notification` and then add details of the channel you'd like to send the feedback to. You can also add tags you’d like to see on the feedback alert. For example, `user.email`. +4. Add an alert name and owner. + + +![Feedback alert conditions =700x](feedback-img/img/feedback-alert-conditions.png) + +Once set up, here's what an example alert looks like: + +![Example feedback alert =600x](feedback-img/img/feedback-example-alert.png) + +## Example Use Cases + +### Thumbs Up/Down Buttons One approach you can take is using thumbs up/down buttons placed contextually within the feature that will trigger the feedback form to open. You can track whether a user clicked on the 👍 or 👎 for each feedback with [custom tags](/platforms/javascript/enriching-events/tags/). The tag will appear on the User Feedback Details page, and optionally on the feedback alert itself after feedback is submitted. -![](feedback-img/img/feedback-thumbs-up-down.png) +**Clever customizations to consider:** +- Use different `messagePlaceholder` text for positive vs. negative feedback ("What did you like most?" vs. "How can we improve?") +- Add custom tags like `feedback.type:positive` or `feedback.type:negative` to easily filter sentiment +- Customize `successMessageText` to encourage specific actions ("Thanks! Want to share more?" vs. "Thanks for helping us improve!") +- Hide name/email fields (`showName: false`, `showEmail: false`) for quick, frictionless feedback +![Thumbs up/down feedback buttons =600x](feedback-img/img/feedback-thumbs-up-down.png)
**See Example JavaScript Code Snippet** @@ -79,50 +173,35 @@ export default function ThumbsUpDownButtons({source}: {source: string) {
+
+### Beta Feature Feedback -## 2. Customize Placeholder Text -Personalized prompts lead to better feedback. Tailor the placeholder text to the feature’s context. - - -Here are examples of placeholder text to guide users: - -> How was your experience with [your feature's name]? - -> How can we make your experience better? +When rolling out a new or experimental feature, add a persistent feedback button directly within the feature UI. Use custom tags to identify which beta feature the feedback relates to, making it easy to aggregate insights and track feedback trends over time. -> We're still building out [your feature's name] - how can we make it better? +**Cusotmizations for Beta Feedback:** +- Enable screenshots (`enableScreenshot: true`) so users can show specific UI issues or suggestions +- Auto-populate user info (`useSentryUser`) to reduce friction for logged-in users +- Customize the button label (`triggerLabel: "Give Feedback on [Feature Name]"`) to be feature-specific +- Use `colorScheme` or custom CSS to match your beta feature's branding +- Add a callback (`onSubmitSuccess`) to show a custom "Thanks for being a beta tester!" message +**Example implementation:** +Add a "Give Feedback" button or link within your beta feature's interface, tagged with `feedback.source:beta-feature-name` and `feedback.type:beta`. This ensures all feedback goes to your product team's dedicated channel. +### Post-Transaction Feedback -It's best to customize your prompts for clarity and relevance; this will guide the user to provide useful input. Use friendly language to encourage honest, casual feedback. +Trigger a feedback prompt after users complete critical actions like checkout, sign-up, or onboarding. This captures their immediate experience while it's fresh in their minds. Use tags to differentiate between transaction types. +**Customizations for Post-Transaction Feedback:** +- Customize `formTitle` and `messagePlaceholder` to match the transaction ("How was checkout?" vs. "How was sign-up?") +- Set `isEmailRequired: true` for post-transaction feedback so you can follow up on issues +- Use `successMessageText` to reinforce the completed action ("Thanks! Your order is on its way") +- Add `onFormClose` callback to redirect users to a confirmation page or next step +- Match your brand colors with custom CSS variables (`--accent-background`, `--foreground`) -## 3. Add Custom Tags to Feedback Submissions For Better Routing - -If you have multiple feedback buttons in your application that are embedded into different features, tags are critical in order to enable faster alert routing and triaging for the right teams. - -You can auto-apply tags based on the widget’s placement. For example, use a custom tag like `feedback.source:checkout`. This allows for routing in Slack and filtering in dashboards. We recommend you define and standardize tags using a single key, such as `feedback.source`. - - -## 4. Set Up Alerts to Relevant Channels -Feedback is only useful if seen by the right folks. - -You can send User Feedback directly into the appropriate team’s channel—whether you use Slack, Microsoft Teams, or Discord (see [complete list of integrations](/product/alerts/create-alerts/routing-alerts/#integrations)). For example, you can tag feedback `feedback.source:checkout` and always have it go to your `#proj-billing` channel in Slack. With this workflow, engineers see feedback in near-real time and take ownership. - -Follow the steps below to set up feedback alerts to relevant channels: - -1. Create a [New Alert Rule](https://sentry.io/alerts/new/issue/) in Sentry. -2. Scroll to the "Set conditions" section and set the "IF" filter to `The issue's category is equal to… "Feedback"` and `The event's tags match... [your custom tag]`. -3. In the “THEN” filter, select `Send a [your integration] notification` and then add details of the channel you'd like to send the feedback to. You can also add tags you’d like to see on the feedback alert. For example, `user.email`. -4. Add an alert name and owner. - - -![](feedback-img/img/feedback-alert-conditions.png) - -Once set up, here's what an example alert looks like: - -![](feedback-img/img/feedback-example-alert.png) +**Example implementation:** +After a successful checkout, display a subtle feedback prompt asking "How was your checkout experience?" Tag it with `feedback.source:checkout` and `feedback.type:post-transaction` to route it to your billing or checkout team. From b1bc69758ae708858176095fa364d4ba1be94e36 Mon Sep 17 00:00:00 2001 From: Shannon Anahata Date: Thu, 16 Oct 2025 10:11:53 -0700 Subject: [PATCH 2/2] refining --- .../sentry-basics/user-feedback-basics.mdx | 20 ++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/product/sentry-basics/user-feedback-basics.mdx b/docs/product/sentry-basics/user-feedback-basics.mdx index 6a9a650f13c73..66d6b329c4a76 100644 --- a/docs/product/sentry-basics/user-feedback-basics.mdx +++ b/docs/product/sentry-basics/user-feedback-basics.mdx @@ -4,9 +4,9 @@ sidebar_order: 2 description: "Learn how to configure and deploy Sentry's User Feedback widget to capture qualitative insights from your users." --- -Sentry's [User Feedback Widget](/product/user-feedback/) is a powerful tool for capturing qualitative insights from real users, and is especially valuable during the rollout of new or beta features. Alternatively, it can be used to collect feedback from your fellow team members during an internal release. +Sentry's [User Feedback Widget](/product/user-feedback/) is a powerful tool for capturing qualitative insights from real users, and is especially valuable during the rollout of new or beta features. It can also be used to collect feedback from your fellow team members during an internal release. -If you treat user feedback as a core signal in product development, especially for betas and early adopter programs, your final product will be better. We recommend adding feedback reviews into planning, stand-ups, or retros; then you can use feedback trends to inform product direction and roadmap decisions. +If you treat user feedback as a core signal in product development, especially for betas and early adopter programs, your final product will result in a better user experience. Once you've configured feedback, we recommend adding feedback reviews into planning, stand-ups, or retros to help inform product direction and roadmap decisions. This 4-step guide will walk you through implementing and instrumenting User Feedback for your application. @@ -73,12 +73,12 @@ Here are examples of placeholder text to guide users: > We're still building out [your feature's name] - how can we make it better? -It's best to customize your prompts for clarity and relevance; this will guide the user to provide useful input. Use friendly language to encourage honest, casual feedback. +It's best to customize your prompts to be specific and clear; this will guide the user to provide useful input. Use friendly language to encourage honest, casual feedback. ## 3. Add Custom Tags to Feedback Submissions For Better Routing -If you have multiple feedback buttons in your application that are embedded into different features, tags are critical in order to enable faster alert routing and triaging for the right teams. +If you have multiple feedback buttons in your application that are embedded into different features, tags are critical in order to enable faster alert routing and triaging to the right teams. You can auto-apply tags based on the widget’s placement. For example, use a custom tag like `feedback.source:checkout`. This allows for routing in Slack and filtering in dashboards. We recommend you define and standardize tags using a single key, such as `feedback.source`. @@ -104,14 +104,20 @@ Once set up, here's what an example alert looks like: ## Example Use Cases + + +The examples and customizations below are available for platforms that support the **User Feedback Widget** (such as JavaScript, React Native, Flutter, Android, and iOS). If you're using a backend SDK, you may have more limited customization options. Check your [platform's documentation](/product/user-feedback/setup/) for specific features and capabilities. + + + ### Thumbs Up/Down Buttons One approach you can take is using thumbs up/down buttons placed contextually within the feature that will trigger the feedback form to open. You can track whether a user clicked on the 👍 or 👎 for each feedback with [custom tags](/platforms/javascript/enriching-events/tags/). The tag will appear on the User Feedback Details page, and optionally on the feedback alert itself after feedback is submitted. -**Clever customizations to consider:** +**Customizations for Thumbs Up/Down Buttons:** - Use different `messagePlaceholder` text for positive vs. negative feedback ("What did you like most?" vs. "How can we improve?") - Add custom tags like `feedback.type:positive` or `feedback.type:negative` to easily filter sentiment -- Customize `successMessageText` to encourage specific actions ("Thanks! Want to share more?" vs. "Thanks for helping us improve!") +- Customize `successMessageText` to encourage specific actions ("Thanks! Want to share more?" or "Thanks for helping us improve!") - Hide name/email fields (`showName: false`, `showEmail: false`) for quick, frictionless feedback ![Thumbs up/down feedback buttons =600x](feedback-img/img/feedback-thumbs-up-down.png) @@ -177,7 +183,7 @@ export default function ThumbsUpDownButtons({source}: {source: string) { ### Beta Feature Feedback -When rolling out a new or experimental feature, add a persistent feedback button directly within the feature UI. Use custom tags to identify which beta feature the feedback relates to, making it easy to aggregate insights and track feedback trends over time. +When rolling out a new or experimental feature, add a feedback button directly within the feature UI. Use custom tags to identify which beta feature the feedback relates to, making it easy to aggregate insights and track feedback trends over time. **Cusotmizations for Beta Feedback:** - Enable screenshots (`enableScreenshot: true`) so users can show specific UI issues or suggestions