---
title: "User Report (Deprecated)"
description: "Deprecated user feedback mechanism — use the Feedback spec instead."
url: https://develop.sentry.dev/sdk/telemetry/user-reports/
---

# User Report (Deprecated)

This document uses key words such as "MUST", "SHOULD", and "MAY" as defined in

<!-- -->

[RFC 2119](https://www.ietf.org/rfc/rfc2119.txt) to indicate requirement levels.

Statusdeprecated

Version`1.2.1`[(changelog)](https://develop.sentry.dev/sdk/telemetry/user-reports.md#changelog)

## [Overview](https://develop.sentry.dev/sdk/telemetry/user-reports.md#overview)

User reports are a deprecated way of submitting user feedback. They associate user information and comments with an existing error event. New implementations **MUST** use the [`feedback` item type](https://develop.sentry.dev/sdk/telemetry/feedbacks.md) instead.

User reports continue to work so older SDKs won't break. If both the item and its associated event are accepted, the backend converts the report into a feedback event.

***

## [Wire Format](https://develop.sentry.dev/sdk/telemetry/user-reports.md#wire-format)

### [Envelope Item](https://develop.sentry.dev/sdk/telemetry/user-reports.md#envelope-item)

Deprecatedspecified since

<!-- -->

1.0.0

Item type `"user_report"`. The item contains a JSON payload:

```json
{
  "event_id": "9ec79c33ec9942ab8353589fcb2e04dc",
  "email": "john@example.com",
  "name": "John Me",
  "comments": "It broke."
}
```

#### [Payload Attributes](https://develop.sentry.dev/sdk/telemetry/user-reports.md#payload-attributes)

| Field      | Type   | Required        | Since | Description                                                                                                                                                                        |
| ---------- | ------ | --------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `event_id` | String | **REQUIRED**    | 1.1.0 | The identifier of the associated event, ideally an error. (since 1.2.0) Updated from "identifier of the event or transaction" to clarify this refers to an associated error event. |
| `email`    | String | **RECOMMENDED** | 1.1.0 | The email of the user.                                                                                                                                                             |
| `name`     | String | **RECOMMENDED** | 1.1.0 | The name of the user.                                                                                                                                                              |
| `comments` | String | **RECOMMENDED** | 1.1.0 | Comments of the user about what happened. (since 1.2.0) Max length: **4096 characters**.                                                                                           |

#### [Constraints](https://develop.sentry.dev/sdk/telemetry/user-reports.md#constraints)

* This Item **MAY** occur once per Envelope.
* User Reports can be ingested separately from their events. However, SDKs **SHOULD** send them in the same Envelope.
* (since 1.2.0) SDKs **MUST NOT** associate multiple User Reports to the same event.
* (since 1.2.0) The event can not be more than 30 minutes old.
* (since 1.2.0) If the event does not exist in the same project or was never ingested, the report is discarded and never converted to feedback.

#### [Envelope Headers](https://develop.sentry.dev/sdk/telemetry/user-reports.md#envelope-headers)

* `event_id`

  **UUID String, required.** Corresponds to the `event_id` field of the payload. (since 1.2.0) If the identifier mismatches between the Envelope and payload, the Envelope header takes precedence.

#### [Additional Item Headers](https://develop.sentry.dev/sdk/telemetry/user-reports.md#additional-item-headers)

*None*

***

## [Public API](https://develop.sentry.dev/sdk/telemetry/user-reports.md#public-api)

### [Capture User Feedback (Deprecated)](https://develop.sentry.dev/sdk/telemetry/user-reports.md#capture-user-feedback-deprecated)

Deprecatedspecified since

<!-- -->

1.1.0

```bash
captureUserFeedback(userFeedback) -> void
```

**Parameters:**

* `userFeedback` — Object containing `event_id` (required), and optionally `email`, `name`, `comments`.

(since 1.2.0) SDKs that still expose this function **SHOULD** mark it as deprecated and direct users to [`captureFeedback`](https://develop.sentry.dev/sdk/telemetry/feedbacks.md#capture-feedback) instead.

***

## [Changelog](https://develop.sentry.dev/sdk/telemetry/user-reports.md#changelog)

| Version | Date       | Summary                                                                                                                                                                                                           |
| ------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `1.2.1` | 2025-01-21 | Typo fix in deprecation description                                                                                                                                                                               |
| `1.2.0` | 2025-01-08 | Deprecated in favor of \`feedback\` item type — added max length (4096) for comments, added constraints (no multiple per event, 30-minute event age limit, discard on missing event), updated event\_id semantics |
| `1.1.0` | 2020-10-30 | Added payload attributes (event\_id, email, name, comments) and JSON example                                                                                                                                      |
| `1.0.0` | 2020-05-05 | Initial spec — user\_report envelope item type, basic constraints, envelope headers                                                                                                                               |