develop icon indicating copy to clipboard operation
develop copied to clipboard

SDK docs for User Feedback v2

Open bruno-garcia opened this issue 1 year ago • 4 comments

The current User Feedback SDK is documented here: https://develop.sentry.dev/sdk/features/#user-feedback

With the new feedback product allowing for capture of feedback outside errors. With the ability to include attachments (e.g: screenshots), tags, and other user context. The protocol has been expanded.

A new API is also being done on JS. Aligning on a new function captureFeedback. The previous captureUserFeedback can be deprecated in favor of the new.

The eventId that we took before is now optional. And the plan is to rename it to something else since the feedback itself will have an id, and eventId is ambiguous.

Document the new envelope format too. Mark the old one as deprecated.

This will unblock in particular the Mobile SDKs

Relates to:

  • https://github.com/getsentry/develop/issues/1208

Worth linking/connecting the two docs ^

bruno-garcia avatar Mar 26 '24 18:03 bruno-garcia

Relates to:

  • https://github.com/getsentry/sentry-javascript/issues/10953

bruno-garcia avatar Mar 26 '24 18:03 bruno-garcia

Relates to:

  • https://github.com/getsentry/sentry-php/issues/1727

bruno-garcia avatar Apr 03 '24 17:04 bruno-garcia

@mydea could you give us a hand with this? I believe we're ready to deprecated captureUserFeedback in favor of the new captureFeedback.

SDK engineers that have captureUserFeedback will be able to add the new function and protocol (with tags etc) and it'll improve the UX

bruno-garcia avatar May 09 '24 15:05 bruno-garcia

@armcknight this is the ticket tracking the develop docs for the new User Feedback API and protocol.

bruno-garcia avatar Jun 27 '24 18:06 bruno-garcia