Skip to content

fix(feedback): Update docs on Feedback attachments #16219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JoshuaMoelans merged 1 commit into from
Feb 4, 2026
Merged

fix(feedback): Update docs on Feedback attachments #16219

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions develop-docs/sdk/data-model/envelope-items.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,12 @@ Use this to explicitly link a related error in the feedback UI.
: _UUID String, optional._ The identifier of a related Session Replay in the same
project. Sentry uses this ID to render a Replay clip in the feedback UI.

**Attaching Screenshots:**
**Attaching Files:**

You can associate screenshots with a feedback by sending image data as
You can attach files of any type to a feedback (screenshots, logs, documents, etc.) by sending them as
[attachment items](/sdk/data-model/envelope-items/#attachment), with `event_id`
corresponding to the feedback item. We recommend sending the items in the same
Envelope.
corresponding to the feedback item. We recommend sending the attachment items in the same
Envelope as the feedback item.

**Constraints:**

Expand Down
12 changes: 8 additions & 4 deletions develop-docs/sdk/telemetry/feedbacks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ For the full list of attributes, see [Event Payloads](/sdk/data-model/event-payl
}
```

### Attaching Screenshots
### Attaching Files

You can associate screenshots with a feedback by sending image data as
You can attach files of any type to a feedback (screenshots, logs, documents, etc.) by sending them as
[attachment items](/sdk/data-model/envelope-items/#attachment), with `event_id`
corresponding to the feedback item. We recommend sending the items in the same
Envelope.
corresponding to the feedback item. We recommend sending the attachment items in the same
Envelope as the feedback item.

## Full Envelope Example

Expand Down Expand Up @@ -102,6 +102,10 @@ Envelope.
"name": "John Smith"
}
}
{"type":"attachment","length":1234,"filename":"screenshot.png"}
Copy link
Contributor

@coolguyzone coolguyzone Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a lot of context here, but it's unclear to me what the 'length' key is referencing here. Will this be something obvious to someone working on a feedback context object? If not, I recommend adding an explainer.

Copy link
Member Author

@JoshuaMoelans JoshuaMoelans Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The length refers to the payload size of the following segment (e.g., <binary screenshot data>). Since we're (supposed to be) adding this to every envelope item already, I think it's fine not to go into details here (as this is already described in detail in the Envelope docs)

<binary screenshot data>
{"type":"attachment","length":567,"filename":"debug-logs.txt"}
<text file content>
```

## Feedback SDK Pipeline
Expand Down