Documentation
Choose the right path, get one feedback flow live, and harden it for production without wading through marketing copy.
- Last reviewed
Documentation
getuserfeedback has three practical starting points:
- install the widget in your app with the JavaScript SDK, React SDK, or GTM
- embed a hosted survey in an iframe or link
- submit responses through the public API and own more of the flow yourself
Start by getting one real path working end to end. Add auth, identity, theming, and consent controls after the first response lands successfully.
Pick the first path
Widget install
Use this if you want to open flows from your product and keep the launch path in your app. Choose React when you already run React, JavaScript SDK when you want framework-agnostic control, or GTM when installation is tag-managed. These paths are documented in Install.
Hosted embed
Use this if you want the fastest hosted survey surface in an iframe or direct link and you do not need to own the full rendering pipeline. This setup also lives in Install.
Public API
Use this if you need to submit responses yourself, resolve published versions explicitly, or fit feedback into an existing backend workflow.
How the docs are organized
- Start Here helps you choose the right path and define the first production-shaped milestone.
- Install covers widget setup and hosted embed setup.
- Build & Launch is for opening flows, passing identity, and handling early failures.
- Customize covers theme mode, containers, and appearance choices.
- Security & Privacy covers JWT auth, consent, and public trust boundaries.
- Reference lists the exact public endpoints, SDK methods, globals, and browser events.
Recommended rollout
- Read Start Here to pick the right launch path.
- Install or embed the first working flow.
- Make one real response land from a production-shaped environment.
- Tighten Security & Privacy before broader rollout.
What good looks like
Stop after this first milestone:
- the app key is wired into the right environment
- one survey or flow opens from the path you chose
- one response lands successfully
- the team knows whether JWT auth, identity, and consent are required at launch
Browse sections
Start with the section that matches your first launch path.
Start Here
Choose the right integration path and get to first success before you harden the details.
Install
Set up the first delivery path, whether that is the widget runtime or a hosted embed.
Build & Launch
Open flows intentionally, pass the right identity, and make the launch path reliable.
Customize
Make the experience feel native without turning docs into a design system.
Security & Privacy
Align the public widget and API surface with your auth perimeter, consent model, and trust boundaries.
Reference
Public endpoints, SDK surfaces, and browser events for direct integrations.