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

In this article:

API Information

This connector uses the following vendor API:

Connector Actions

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

Configure Settings

Go to the Connector Marketplace and add a new connector. Read the Connector Overview article for general instructions on how to add a connector.

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.

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  
Public