Qualtrics XM Directory Connector Setup Guide

This article describes how to set up the Qualtrics XM Directory connector.

API Information

This connector uses the following vendor API:

  • API Name: Qualtrics XM Directory API
  • API Version: v3
  • API Endpoint: https://ca1.qualtrics.com
  • Documentation: Qualtrics XM Directory API

Connector actions

Action Name AudienceStream EventStream
Create or Update Directory Contact
Create Contact Transaction

Configure settings

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see the About Connectors article.

After adding the connector, configure the following settings:

  • Data Center ID
    • Your Data Center ID can be found by going to Account Settings > Qualtrics IDs> IDs > Box User.
  • Client ID
    • Provide your web application Client ID that has access to the Qualtrics XM Directory API.
    • Your Client ID can be found by going to Account Settings > Qualtrics IDs > OAuth Client Manager.
    • Your Qualtrics XM Directory API OAuth Client Manager Page must contain the following Grant Type:
      • client_credentials and Scopes must be: manage:contact_transactions, manage:directory_contacts, read:directories, and read:mailing_lists.
    • For additional information, see OAuth authentication (client credentials) and OAuth 2.0 Scopes.
  • Client Secret
    • Provide your web application client secret.

When creating your application within Qualtrics, configure the redirect URLs to match your Tealium environment. For example: https://sso.tealiumiq.com/oauth/qualtrics/callback.html for SSO enabled customers and https://my.tealiumiq.com/oauth/qualtrics/callback.html for standard customers.

Action settings - parameters and options

Click Next or go to the Actions tab. This is where you configure connector actions.

This section describes how to set up parameters and options for each action.

Action - create or update directory contact

Parameters

Parameter Description
Update Strategy
  • Required.
  • Select applicable update strategy.
    • Create Only: Look up an existing contact and if not found, create a new contact.
    • Update Only: Look up an existing contact and update it.
    • Create or Update: Look up an existing contact and if found, update it, otherwise create a new contact.
Directory
  • Required
  • Select the directory to create or update the contact in.
FirstName
LastName
Email
Phone
ExtRef
Language
Unsubscribed
FirstName
LastName
Email
Phone
ExtRef
Language
Unsubscribed
Embedded Data
  • The embedded data object contains extra metadata that you want to associate with contacts.
  • This user-defined data could include such data as birthplace, gender, employment status, etc.
ContactId
FirstName
LastName
Email
Phone
ExtRef
Language
Unsubscribed

Action - Create contact transaction

Parameters

Parameter Description
Directory
  • Required
  • Select the directory to create or update the contact in.
Mailing List
  • Required
  • Select the mailing list to create the contact transaction in.
ContactId
FirstName
LastName
Email
Phone
ExtRef
Language
Unsubscribed
Transaction Date

Was this page helpful?

This page was last updated: August 9, 2021