In-app SDK
With the SDK, people can send feedback without leaving your app. Their feedback shows up in Reviews next to store reviews. They can also vote on roadmap items and request features, which show up in Roadmap.
For App Store apps, Uprate can match a rating prompt from the SDK to an App Store review that arrives later. It shows the likely match and how confident it is. A match is not proof that the same person wrote the review. Google Play reviews are not matched.
Get SDK keys
- Select your app in Uprate and open SDK.
- Create a key pair.
- Put the publishable key in your mobile app.
- Keep the secret key on your server. Uprate shows it only once.
SDK keys belong to one app. Never ship the secret key in a mobile build. A REST API key from Settings does not work as an SDK key.
Install steps are in the SDK repositories: iOS and Android.
Verify users
The publishable key is inside your app, so anyone can copy it and send any user ID. A user token proves that your server stands behind the ID. Your server creates it after the person signs in, and your app sends it with every SDK request in the X-SDK-User-Token header, next to X-SDK-User-Id.
The token is a hex HMAC-SHA256 of the exact user ID. Its key is the hex SHA-256 of the secret key from the same key pair, because Uprate stores only that fingerprint of your secret.
// Node.js, on your server
import { createHash, createHmac } from 'node:crypto';
const key = createHash('sha256').update(process.env.UPRATE_SDK_SECRET).digest('hex');
const userToken = createHmac('sha256', key).update(userId).digest('hex');// PHP, on your server
$userToken = hash_hmac('sha256', $userId, hash('sha256', getenv('UPRATE_SDK_SECRET')));# Python, on your server
import hashlib, hmac, os
key = hashlib.sha256(os.environ["UPRATE_SDK_SECRET"].encode()).hexdigest().encode()
user_token = hmac.new(key, user_id.encode(), hashlib.sha256).hexdigest()Return the token to your app with the rest of the sign-in data. It doesn't expire. Regenerating the key pair makes every token of that pair stop working.
Once your app sends tokens, turn on Require verified users under SDK keys. With it on:
- A person's own feedback, feature requests and replies are readable only with a valid token. Without one, the SDK gets a
401with the codeuser_token_required. - Without a valid token, the roadmap still loads with its vote counts, but no item shows as voted by that person.
- Only requests with a valid token change the name and email you see in Uprate.
- Sending feedback, feature requests and votes works with the user ID alone.
- The hosted web form can't prove who is writing, so its messages arrive as anonymous, with the email and name the person or link gave.
A token that doesn't match the user ID is always rejected with a 401 and the code user_token_invalid, even when the switch is off.
In the SDKs, pass the token as userToken together with the user ID in setUserContext. The SDK then sends it with every request.
Reply by email
You can answer a person's feedback by email from Reviews when their email came with it. In the SDK, send it in the X-SDK-User-Email header next to X-SDK-User-Id. The hosted web form asks for it.
- The reply goes to the address that came with that feedback, in the language of the person's device.
- Feedback without an email, or from an app made for kids, can't get a reply by email. Your app can still show it, see Replies in your app.
- Set the sender name, reply address, logo and footer in SDK › Reply emails.
Replies in your app
Your app can show your replies to a person's feedback, also when you don't know their email. Ask for unread replies when the app opens or comes back to the foreground, show them your way, for example as a badge or a banner, then mark the ones the person saw as read.
- iOS and Android:
feedback.getUnreadReplies()andfeedback.markRead(replies). - React Native:
client.feedback.getUnreadReplies()andclient.feedback.markRead(replies). - Over HTTP:
GET /api/sdk/v1/replies/unreadreturns up to 100 unread replies, oldest first.POST /api/sdk/v1/replies/readwith{"uuids": [...]}marks them read and keeps the first time.GET /api/sdk/v1/feedbacklists each item's replies.
How it behaves:
- Reviews offers a reply in the app once your app asked for replies at least once. Until then, only people with an email can get a reply.
- A reply reaches the app after the ten seconds in which you can undo it. Someone who also gave an email gets it both ways.
- Reviews shows Unread in app until your app marks the reply read, then Read in app. If the person's own app never asked for replies, Reviews says so, because they see the reply only after updating.
- A reply to an app made for kids shows only in the app. Uprate sends no email.
- People from the hosted web form whom your app didn't identify can't get a reply in the app.
- With Require verified users on, replies need the user token.
Push notifications
Your app can also get a push notification when you reply, even while it's closed. The notification says only that a reply is waiting, in the person's language, never the reply itself, so a lock screen or a shared phone doesn't show it. When the person taps it, your app asks for unread replies.
- In SDK › Push, upload the key for each store your app is on: an APNs auth key (the
.p8file, its Key ID and your Team ID) for iOS, and a Firebase service account key (JSON, from Project settings › Service accounts) for Android. The App Store Connect API key andgoogle-services.jsoncan't send pushes. Uprate stores the keys encrypted and never shows them again. - In your app, ask for notification permission and get the device's push token. Register it after
setUserContextand again whenever it changes. Unregister it beforeclearUserContextwhen the person logs out.- iOS:
feedback.registerPushToken(deviceToken)with the APNs device token fromdidRegisterForRemoteNotificationsWithDeviceToken, andfeedback.unregisterPushToken(deviceToken). - Android:
feedback.registerPushToken(token)with the FCM registration token, andfeedback.unregisterPushToken(token). - React Native:
client.feedback.registerPushToken({ token, provider: 'apns' })(or'fcm') with the native device token, for example fromgetDevicePushTokenAsync()inexpo-notifications. An Expo push token doesn't work. - Over HTTP:
POST /api/sdk/v1/push-tokenswith{"token": "…", "provider": "apns"}or"fcm"in the body.DELETEwith the same body removes it. A token for a store your app isn't on gets a 422 that names the right one.
- iOS:
- When a notification arrives,
UprateFeedback.replyId(fromPush: userInfo)on iOS,UprateFeedback.replyId(data)on Android orreplyIdFromPush(data)in React Native returns the reply's id if the push is from Uprate. Withexpo-notifications, passnotification.request.content.data. On tap, callgetUnreadReplies().
How it behaves:
- Each registered device gets one push when a reply first reaches the app, after the ten seconds in which you can undo it. Sending an email again doesn't push again, and replies sent before you uploaded a key don't push.
- The push carries
uprate_reply_uuidanduprate_feedback_uuid. On iOS they're also underbody, whereexpo-notificationsreads a push's data, and the push is in theuprate-feedback-repliesthread. On Android a newer push about the same reply replaces the older one. - Pushes to iPhones go to the bundle ID Uprate reads from the App Store. Tokens from debug builds work too.
- A person keeps their 10 newest devices. A device registered by someone else, for example after logging in on a shared phone, moves to them.
- Uprate removes devices Apple or Google no longer know. If Apple or Google refuses your key, SDK › Push says why and what to do.
- With Require verified users on, registering a device needs the user token.
- Apps made for kids can't use push notifications, because a device token is a lasting identifier.
Apps made for kids
If your app is in the App Store Kids category or Google Play's Families program, don't send a child's identity to Uprate. Leave out X-SDK-User-Email and X-SDK-User-Name, use a random ID in X-SDK-User-Id instead of an email or username, and keep personal details out of metadata.
Then turn on Made for kids in the app's settings in Uprate. With it on:
- Uprate drops the name and email from every SDK request. It still stores the user ID, device platform and app version your app sends.
- The hosted web form doesn't ask for an email. It keeps only the message and a random ID of the install, and ignores the user ID, email and name in the link. It stores no device details, language or time zone.
- Feedback arrives without an email, so you can reply to the sender only in your app.
Turning it on doesn't remove names and emails Uprate stored earlier. To remove one person and everything they sent, open their feedback in Reviews and choose Delete user and their data.
Read a person's history
GET /api/sdk/v1/feedback and GET /api/sdk/v1/roadmap/requests return the person's own items, newest first, at most 50 per page. Each feedback item has the replies your app can show. Ask for up to 100 with limit. When more items exist, the response has a next_cursor. Pass it back as cursor to get the next page. A next_cursor of null means you have everything.
Connect an AI agent over MCP
Uprate runs an MCP server for coding agents and AI assistants. Copy its URL from Settings > MCP, add it to your agent, then sign in to Uprate and choose which apps the agent may use. The agent gets only your permissions on those apps. MCP server has the setup for each client, every tool and how approvals work.
REST API keys do not work for MCP. You can disconnect an agent in Settings > MCP.
For server code that uses API keys, see REST API.