Set Up User Feedback

The User Feedback feature allows you to collect user feedback from anywhere inside your application at any time, without needing an error event to occur first.

Note that if you're using a self-hosted Sentry instance, you'll need to be on version 24.4.2 or higher in order to use the full functionality of the User Feedback feature. Lower versions may have limited functionality.

User Feedback iOS	User Feedback Android

User Feedback Form

The user feedback form allows users to submit feedback from anywhere inside your application.

To collect user feedback from inside your application use the showFeedbackForm method.

import * as Sentry from "@sentry/react-native";

Sentry.wrap(RootComponent);

Sentry.showFeedbackForm();

Note that the root application component must be wrapped with Sentry.wrap for the showFeedbackForm method to work. The method depends on the React Native Modal implementation. It is supported fully in the legacy architecture. For the new architecture (Fabric renderer) it requires React Native 0.71 and up.

To configure the form you can use the Sentry.feedbackIntegration({}) or add it to your Sentry initialization.

import * as Sentry from "@sentry/react-native";

Sentry.init({
  dsn: "___PUBLIC_DSN___",

  integrations: [
    Sentry.feedbackIntegration({
      // Additional SDK configuration goes in here, for example:
      styles: {
        submitButton: {
          backgroundColor: "#6a1b9a",
        },
      },
      namePlaceholder: "Fullname",
    }),
  ],
});

There are many options you can pass to the integration constructor. See the configuration documentation for more details.

Shake to Report

You can enable shake-to-report so that shaking the device opens the Feedback Form. Enable it declaratively via the feedbackIntegration option:

Sentry.feedbackIntegration({
  enableShakeToReport: true,
});

Or control it programmatically:

// Start listening for shake gestures to open the feedback form
Sentry.enableFeedbackOnShake();

// Stop listening for shake gestures
Sentry.disableFeedbackOnShake();

Feedback Form Component

You can also integrate the FeedbackForm component manually in your app.

import { FeedbackForm } from "@sentry/react-native";

<FeedbackForm />;

For the full set of options you can pass to the FeedbackForm component see the configuration documentation.

Session Replay

The User Feedback Form integrates seamlessly with Session Replay. When the widget is opened, the SDK buffers up to 30 seconds of the user's session. If feedback is submitted, this replay is sent along with the feedback, allowing you to view both the feedback and the user's actions leading up to the feedback submission.

User Feedback API

The user feedback API allows you to collect user feedback while utilizing your own UI. You can use the same programming language you have in your app to send user feedback. In this case, the SDK creates the HTTP request so you don't have to deal with posting data via HTTP.

Sentry pairs the feedback with the original event, giving you additional insight into issues. Sentry needs the eventId to be able to associate the user feedback to the corresponding event. For example, to get the eventId, you can use beforeSendor the return value of the method capturing an event.

import * as Sentry from "@sentry/react-native";
import { SendFeedbackParams } from "@sentry/react-native";

const sentryId = Sentry.captureMessage("My Message");
// OR: const sentryId = Sentry.lastEventId();

const userFeedback: SendFeedbackParams = {
  name: "John Doe",
  email: "john@doe.com",
  message: "Hello World!",
  associatedEventId: eventId, // Optional
};

Sentry.captureFeedback(userFeedback);

You can also attach further data to the feedback event by passing a hint as a second argument. This is similar to other capture methods:

Sentry.captureFeedback(
  { message: "I really like your App, thanks!" },
  {
    captureContext: {
      tags: { key: "value" },
    },
    attachments: [
      {
        filename: "hello.txt",
        data: "Hello, World!",
      },
    ],
  },
);