Install the Responsly Mobile SDK in your app

Installing the SDK is a task for the developer of your app, done once. This article explains what they need from you and what to agree on before they start. The technical steps are in the Mobile SDK documentation.

What to give your developer

  1. Open a form in Responsly and go to Share → Mobile app.
  2. Scroll to the Installation card.
  3. Copy the SDK key and send it to your developer with the link to the documentation.

The Installation card with the SDK key, the Survey ID, a code sample for iOS and the link to the Mobile SDK documentation

What it isWhen the developer needs it
SDK keyA key that starts with rsk_. One per team, the same for iOS and Android. It is not a secret.Always: the SDK starts with it.
Survey IDIdentifies one form.Only to open that form from the app’s own code, for example from a “Give feedback” button.

The card also shows a short code sample for each platform, ready to copy.

Note: No Mobile app tab? Mobile app surveys are switched on per team, and the SDK packages are provided on request. Write to contact@responsly.com.

Supported platforms

PlatformMinimum versionDocumentation
iOSiOS 15iOS installation
AndroidAndroid 6.0Android installation
React Native, including Expo development buildsReact Native 0.75React Native installation
FlutterFlutter 3.24Flutter installation
UnityUnity 2022.3 LTSUnity installation

What the developer adds to the app

  • Starting the SDK when the app starts, with your SDK key.
  • Events. A line of code wherever something worth reacting to happens, such as a finished purchase. You then use the event’s name as a trigger.
  • Screens. The name of the screen the user is on, if you want surveys tied to screens.
  • The user. Optionally, the user’s ID and attributes such as their plan or country. You can target surveys with them and save them with responses. See Identify app users and pass data to responses.

After that, no survey appears on its own. A form is shown only when its Mobile app channel is on and one of its rules matches.

Agree on names first

Triggers and audience rules compare names exactly, including upper and lower case. purchase_completed and Purchase Completed are two different events. Before the developer starts, write down together:

WhatExampleWhere you use it
Event namespurchase_completed, onboarding_finishedWhen to show, trigger type Event
Event propertiestotal, categoryConditions on an event trigger
Screen namesOrderConfirmation, SettingsWhen to show, trigger type Screen
User attributesplan, country, signed_upWho sees it, and hidden fields of the form

Tip: Keep the list where both of you can reach it. When a survey does not appear, a name spelled differently in the app and in Responsly is the most common reason.

Check that it works

  1. Switch the Mobile app channel on for a test form and add a trigger with an event the app sends.
  2. Set Share of users to 100 and the frequency to Every time while testing.
  3. Wait about 10 minutes, or reinstall the test build, so that the app has the new settings.
  4. Run the app and do the action. The survey should appear.

If it does not, see Mobile app surveys: FAQ and troubleshooting. Developers can turn on the SDK’s debug log, which says why a survey was not shown: Testing & debugging.

FAQ

Where do I find the SDK key?

Open any form, go to Share → Mobile app and scroll to the Installation card. The key starts with rsk_ and is the same for every form of your team.

Is the SDK key a secret?

No. It only identifies your team when the app downloads its survey settings, so it can be part of the app and of its source code. One key is used for iOS and Android.

How do I get the SDK packages?

The packages are provided on request. Write to contact@responsly.com with the name of your team and the platforms you build for.

Need help or have more questions?