> For the complete documentation index, see [llms.txt](https://rudderlabs.gitbook.io/rudderlabs-1/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rudderlabs.gitbook.io/rudderlabs-1/docs/destinations/marketing/qualtrics.md). # Qualtrics Step-by-step guide to send your event data from RudderStack to Qualtrics. [**Qualtrics**](https://www.qualtrics.com/au/core-xm/survey-software/) is a popular survey software that lets you create intelligent, real-time user surveys. It lets you get cutting-edge insights into your customers and use them to boost your brand value. RudderStack lets you configure Qualtrics as a destination to which you can send your event data directly. ## Getting Started Before configuring Qualtrics as a destination in RudderStack, verify if Qualtrics supports the source platform you are sending the events from. Refer to the following table: | **Connection Mode** | **Web** | **Mobile** | **Server** | | ------------------- | ------------- | ------------- | ---------- | | **Device mode** | **Supported** | **Supported** | - | | **Cloud mode** | - | - | - | To know more about the difference between Cloud mode and Device mode in RudderStack, read the [RudderStack connection modes](https://rudderstack.com/docs/rudderstack-cloud/rudderstack-connection-modes/) guide. Once you have confirmed that the source platform supports sending events to Qualtrics, follow these steps: * From your [**RudderStack dashboard**](https://app.rudderstack.com/), add the source and select **Qualtrics** from the list of destinations. ![Configuration Settings for Qualtrics](https://user-images.githubusercontent.com/59817155/128999630-37a8cac7-cd8c-4ba8-8b15-1435afeff4ca.png) ### Configuration Settings To successfully configure Qualtrics as a destination, you will need to configure the following settings: * **Project ID:** Enter your Qualtrics Project ID here. * **Brand ID:** Enter your Qualtrics Brand ID here. Refer to the **FAQ** section below for steps on how to get your Qualtrics Project ID and Brand ID. * **Enable Generic Page Title:** If this field is enabled, RudderStack sends every `page` call with the name `Viewed a Page`. This field is useful only when using the `page` call. If this option is disabled, RudderStack will search for the category and name of the `page` call and send the event as `Viewed Page`. If any of the two fields is absent, RudderStack sends the `page` call as `Viewed / Page`. ## Adding device mode integration iOS Android To add Qualtrics to your iOS project, follow these steps: * In your `Podfile`, add the `Rudder-Qualtrics` extension as shown: ```ruby pod 'Rudder-Qualtrics' ``` * After adding the dependency followed by a `pod install` command, add the following imports to your `AppDelegate.m` file: ```objectivec #import #import @import Qualtrics; ``` * Then, add the initialization of your `RSClient` as shown: ```objectivec RSConfigBuilder *configBuilder = [[RSConfigBuilder alloc] init]; [configBuilder withDataPlaneUrl:DATA_PLANE_URL]; [configBuilder withFactory:[RudderQualtricsFactory instance]]; [RSClient getInstance: config:[configBuilder build]]; ``` * Next, add the following snippet to display the qualified intercept on your `ViewController`: ```objectivec [Qualtrics.shared evaluateProjectWithCompletion:^(NSDictionary* targetingResults){ for (NSString* interceptID in targetingResults) { TargetingResult *result = targetingResults[interceptID]; if ([result passed]) { [[Qualtrics shared] displayWithViewController:self]; } } }]; ``` For more information, refer to the [**Qualtrics iOS documentation**](https://api.qualtrics.com/sdks/ZG9jOjgwNTgzNjY-getting-started-with-the-mobile-app-sdk-on-i-os). Your Android project must be on **version 5.0 (API level 21) or higher** for RudderStack to be able to send events to Qualtrics.
Once confirmed, follow these steps to add Qualtrics to your Android project: * Open your `app/build.gradle` (Module: app) file and add the following under the `dependencies` section : ```groovy implementation 'com.rudderstack.android.sdk:core:1.+' implementation 'com.rudderstack.android.integration:qualtrics:1.0.0' implementation 'com.google.code.gson:gson:2.8.6' // Qualtrics implementation 'com.qualtrics:digital:2.0.0' ``` * Add a new Maven repository for the App Feedback package. Your `allprojects` section should appear as shown: ```groovy allprojects { repositories { google() jcenter() maven { url "https://s3-us-west-2.amazonaws.com/si-mobile-sdks/android/" } } } ``` * Open the `AndroidManifest.xml` file from the `src/main` folder in the project root and add the following XML snippet after the existing activity: ```markup ``` * Initialize the RudderStack SDK in your `Application` class' `onCreate()` method as shown: ```kotlin // initializing Rudder SDK val rudderClient = RudderClient.getInstance( this, , RudderConfig.Builder() .withDataPlaneUrl(DATA_PLANE_URL) .withFactory(QualtricsIntegrationFactory.FACTORY) .build() ) ``` * Add a `MyCallback` subclass. You need to implement a callback for the Qualtrics APIs. This will be used to call the `displayIntercept()` method based on the `evaluateIntercept()` result. A good place to add this callback is before the last closing brace (`}`) in your `MainActivity.Java` class. Add the following code: ```java private class MyCallback implements IQualtricsProjectEvaluationCallback { @Override public void run(Map targetingResults) { for (Map.Entry result: targetingResults.entrySet()) if (result.getValue().passed()) { Qualtrics.instance().displayIntercept(MainActivity.this, result.getKey()); } } } ``` * Add the following snippet to display the qualified intercept in your activity class: ```java Qualtrics.instance().evaluateProject(new MyCallback()); ``` For more information, refer to the [Qualtrics Android documentation](https://api.qualtrics.com/sdks/ZG9jOjgwNTgzNjE-getting-started-with-mobile-app-sdk-on-android). In the iOS Device Mode implementation, even if the user qualifies for multiple intercepts, only one will be shown. Whereas in Android, all the intercepts for the user will be shown. ## Page The `page` call lets you record your website's page views with any additional relevant information about the viewed page. RudderStack passes any tracked events as embedded data to the Qualtrics [**intercept**](https://www.qualtrics.com/support/website-app-feedback/getting-started-with-website-app-feedback/step-4-setting-up-your-intercept/) target. After the `page` call, the Qualtrics survey is loaded. You can set the intercepts when a user creates the project or after they have created the project. A sample `page` call is as shown: ```javascript rudderanalytics.page("category", "name", { path: "path", url: "url", title: "title", search: "search", referrer: "referrer", testDimension: "true" }); ``` For the above example, The event will be sent as `Viewed category name Page`, if the **Generic Page Title** option is disabled in the RudderStack dashboard. If this option is enabled, the event will be sent as `Viewed a Page`. If the category field is not mentioned in the `page` call but specified inside the properties, RudderStack still includes the field while sending the event. For example, refer to the following snippet: ```javascript rudderanalytics.page("name", { category: "category", path: "path", url: "url", title: "title", search: "search", referrer: "referrer", testDimension: "true" }); ``` For the above example, the event will be sent as `Viewed category name Page`, if the **Generic Page Title** option is disabled in the RudderStack dashboard. If it is enabled, the event will be sent as `Viewed a Page`. If `category` is not specified in the event at all, RudderStack sends the event with only the page name, as shown below: ```javascript rudderanalytics.page("name", { path: "path", url: "url", title: "title", search: "search", referrer: "referrer", testDimension: "true" }); ``` For the above example, The event will be sent as `Viewed name Page`, if the **Generic Page Title** option is disabled in the RudderStack dashboard. If enabled, the event will be sent as `Viewed a Page`. If both the name and category fields are absent in the `page` call and the **Generic Page Title** option is disabled, RudderStack will not send the event to Qualtrics. ## Track The `track` call lets you track how many times a user performs certain actions. RudderStack passes any tracked events as embedded data to the Qualtrics [**intercept**](https://www.qualtrics.com/support/website-app-feedback/getting-started-with-website-app-feedback/step-4-setting-up-your-intercept/) target. After the `track` call, the Qualtrics survey is loaded. At the destination end, i.e. Qualtrics, both `page` and `track` calls have the same functionality. You can set the intercepts when a user creates the project or after they have created the project. In this case, the value of event field of the `track` call will be used as the event name while sending it to Qualtrics. A sample `track` call is as shown: ```javascript rudderanalytics.track("Test Event"); ``` In the above example, the event will be sent to Qualtrics as `Test Event`. ## Identify The `identify` call is supported only in the mobile (Android and iOS) Device Mode integration. When you make an `identify` call, RudderStack sets the user traits using: * The Qualtrics `Properties` class, `setString`, and `setNumber` API in case of Android, and * The `setStringWithString` and `setNumberWithNumber` API in case of iOS These user traits can be used as custom properties while setting the [**Target Logic**](https://www.qualtrics.com/support/website-app-feedback/common-use-cases/optimizing-intercept-targeting-logic/) or [**Embedded Data**](https://api.qualtrics.com/sdks/ZG9jOjgwNTgzNjE-getting-started-with-mobile-app-sdk-on-android#using-embedded-data) for any intercept in your Qualtrics dashboard. iOS Android ```objectivec [[RSClient sharedInstance] identify:@"test_user_id" traits: @{ @"property_key": @"property_value" }]; ``` ```kotlin MainApplication.rudderClient.identify( RudderTraits() .put("property_key", "property_value") ) ``` ## FAQ ### How do I get my Project ID and Brand ID? To get your Qualtrics Project ID and Brand ID, follow these steps: * Log into your [**Qualtrics account**](https://login.qualtrics.com/login?lang=au). * Click on the project you will be using. * Click on **Settings** tab, followed by **Manage Project** option (the right-most dropdown menu in the dashboard). ![](https://user-images.githubusercontent.com/59817155/128864100-05ef5c5a-8c04-4607-b742-633938f440ac.png) * Click on **Project ID's**. Here you will find both your Project ID and Brand ID, as shown: ![](https://user-images.githubusercontent.com/59817155/128864303-2660ccb8-a91d-4633-b6bf-eef4253cb381.png) ### How do I know if the SDK has loaded successfully? Once RudderStack loads the web SDK successfully, you will be able to see the survey options chosen in the Qualtrics dashboard, e.g., a survey button, survey form, etc. An example is shown below: ![](https://user-images.githubusercontent.com/59817155/128988678-5f108062-6072-47e0-94d1-d3e7bee15fe5.png) ### In the mobile Device Mode integration, is it possible to manually set the logic? Yes, you can manually set the logic using Qualtrics `Properties` class `setString` and `setNumber` API on Android and `setStringWithString` and `setNumberWithNumber` API on iOS. For more information, refer to the [**iOS documentation**](https://api.qualtrics.com/sdks/ZG9jOjgwNTgzNjY-getting-started-with-the-mobile-app-sdk-on-i-os) or the [**Android documentation**](https://api.qualtrics.com/sdks/ZG9jOjgwNTgzNjE-getting-started-with-mobile-app-sdk-on-android), depending on your implementation. ## Contact Us For questions on any of the sections covered in this guide, feel free to [**contact us**](mailto:docs@rudderstack.com) or start a conversation in our [**Slack**](https://rudderstack.com/join-rudderstack-slack-community) community.