Beta SDK
Learn about general User Feedback configuration fields for version 7 of the JavaScript SDK.
Deprecation Warning
In version 7 of our JavaScript SDK, User Feedback was released as a Beta integration. We recommend updating your SDK to version 8.
You can customize the Crash-Report modal to your organization's needs, for example, for localization purposes. All options can be passed through the Sentry.showReportDialog call.
| Param | Default |
|---|---|
eventId | Manually set the id of the event. |
dsn | Manually set dsn to report to. |
user | Manually set user data [an object with keys listed below]. |
user.email | User's email address. |
user.name | User's name. |
lang | [automatic] – (Override for Sentry’s language code.) |
title | It looks like we’re having issues. |
subtitle | Our team has been notified. |
subtitle2 | If you’d like to help, tell us what happened below. – (Not visible on small screen resolutions.) |
labelName | Name |
labelEmail | |
labelComments | What happened? |
labelClose | Close |
labelSubmit | Submit |
errorGeneric | An unknown error occurred while submitting your report. Please try again. |
errorFormEntry | Some fields were invalid. Please correct the errors and try again. |
successMessage | Your feedback has been sent. Thank you! |
onLoad | n/a - (An optional callback that will be invoked when the widget opens.) |
onClose | n/a - (An optional callback that will be invoked when the widget closes.) |
The optional callback onLoad will be called when users see the widget. You can use this to run custom logic, for example to log an analytics event:
Copied
Sentry.showReportDialog({
// ...
onLoad() {
// Log an event to amplitude when the report dialog opens
amplitude.logEvent('report_dialog_seen');
},
});
The optional callback onClose will be called when users close the widget. You can use this to run custom logic, for example to reload the page:
Requires JS SDK version v7.82.0 or higher.
Copied
Sentry.showReportDialog({
// ...
onClose() {
// Refresh the page after the user closes the report dialog
location.reload();
},
});
Help improve this content
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").