Set up User Reporting#

Integrate the User Reporting SDK with your app to set up user reports. Once integrated, you can use the built-in user report prefab, or create your own custom user reports without the prefab.

To add the built-in example User Reporting Prefab to your project:

1. Open the Package Manager in the Editor, then locate the User Reporting package and select the Samples tab.
2. Locate the User Reporting Example, and select Import.
3. In your project, add the User Reporting Prefab to the desired scene.
4. In your Assets folder, open Samples and select the User Reporting folder.
5. Open the folder titled with the package version you installed (for example, 1.0.0).
6. Open the User Reporting Example folder.
7. Drag and drop the UserReportFormExample prefab into your scene.

Set up notifications for new reports#

User Reporting supports new report notifications via Integrations so you can connect your development workflow to non-Unity tools. Receive a notification via third-party integrations such as email, Slack, Discord, Trello, and more.

To set up notifications:

1. Open the Unity Cloud Dashboard.
2. Select your desired project from the project selector on the top menu. Note: Make sure you’ve added and enabled User Reporting for the project before setting up report notifications.
3. From the main menu, select Projects.
4. Select Project Settings > Integrations.
5. Select New Integration and follow the instructions in the dialog for the integration you want to use.

Test reports and notifications#

The sample scene is an effective tool for confirming whether or not your User Reporting has been set up correctly. In this example, we’ll optionally include a test of the email notification integration for new reports.

To set up email notifications (optional):

1. Open the Unity Cloud Dashboard.
2. Select your project from the top navigation menu. Note: Make sure you’ve added and enabled User Reporting for the project before setting up report notifications.
3. Select Projects.
4. Select Project Settings > Integrations.
5. Select New Integration and follow the instructions in the dialog for Email integration. Enable the Report Received event option.

To test that reports are received:

1. Open your Unity project.
2. In your Assets folder, open Samples and select User Reporting.
3. Locate the UserReportingExample.unity scene in the User Reporting Example folder.
4. Start the scene. Click anywhere to spawn a cube in the scene, the select Create Report to open the submission form.
5. Fill out the form and select Submit, and check the report is sent successfully.
6. Open the Unity Cloud Dashboard.
7. Select your project from the project selector on the top menu.
8. Select Cloud Diagnostics > User Reporting.
9. Wait a few minutes, then your report is visible on the dashboard. If you optionally set up an integration, you can see that the notification arrives close to the same time the report appears.