Feedback SDK
Embed @deck-io/feedback widgets so in-product feedback flows into Deck.
Feedback SDK
The Feedback SDK is Deck’s official package for collecting in-product feedback — from React UIs in the browser or from Node/server code.
| Package | @deck-io/feedback (0.2.0+) |
| Client entry | @deck-io/feedback — React 18+ (peer) |
| Server entry | @deck-io/feedback/server — Node / Route Handlers / Server Actions (no React) |
| Auth | Publishable keys (pk_…) |
| Ingest | POST widget feedback API |
Use it when you want customers to share feedback inside your product — after a feature launch, on a settings page, next to an AI response, from a backend failure path, or anywhere you own the UX.
Submissions land in Deck under Manage → Widgets. Written feedback is synthesized into insights and themes on a weekday batch schedule.
When to use this SDK
| Use the Feedback SDK when… | Prefer something else when… |
|---|---|
| You need thumbs, a dialog, or a custom form in your app | You need server-side access to themes, insights, or Build data → Public API |
| You need to submit feedback from Node / Next.js server code | You need secret dk_… keys for the Public API (never put those in this SDK) |
Auth must be safe in the browser (publishable pk_…) | You only need one-off CSV / interview uploads in the Deck app |
| Feedback should appear as a first-class Deck source |
What you get
DeckProvider— publishable-key auth, user identity, URL privacy, theming- Built-in UI —
FeedbackDialog,ThumbsFeedback - Headless APIs —
useSubmitFeedback, low-levelsubmitFeedback - Server client —
createDeckFeedbackClientfrom@deck-io/feedback/server - Privacy-safe defaults — browser URL metadata is origin + pathname only (no query/hash)
Guides in this section
- Install
- Setup in Deck — widgets and publishable keys
- Quick start
- DeckProvider
- Built-in components
- Headless submit
- Server-side submit
- Identity and context
- URL privacy
- Theming
- Where feedback goes
- Security
- API reference
- Troubleshooting
Prerequisites
- A Deck organization with Feedback Widgets enabled
- A widget (
wgt_…) from Manage → Widgets - A publishable key (
pk_…) from Settings → Feedback Widget SDK - For the React entry: a React app with
reactandreact-dom≥ 18 - For the server entry: Node ≥ 20 (no React required)
Feedback Widgets setup pages must be enabled for your Deck organization before
you can create widgets or publishable keys. The npm package is public; live
submissions still require a valid widget ID and pk_… key from Deck.
Next step
Start with Install, then Setup in Deck.