# Qualtrics Destination

[Qualtrics](https://qualtrics.com) is an Experience Management platform that allows companies to design and improve customer and employee experiences through listening, analysis and action. Power richer Qualtrics insights or perform action based on your event data using the Qualtrics destination

## Benefits of Qualtrics (Actions)

Qualtrics (Actions) provides the following benefits:

* **Keeping your contact data in sync**. The Qualtrics destination provides actions to sync your contact data from your system of record up to date with Qualtrics XiD
* **Streamlined configuration**. Qualtrics destination maps your event data to the Qualtrics API & Qualtrics xflow (workflows) out of the box

### Limitations

The Qualtrics destination is only available to customers on a Business Tier plan with Segment.

To link your Qualtrics destination in Segment to your Qualtrics workspace, [Qualtrics](https://www.qualtrics.com/support/integrations/twilio-segment/twilio-segment-task/) requires a [Segment Token](https://app.segment.com/goto-my-workspace/settings/access-management/tokens) that can only be generated by Business Tier customers who have access to the [Public API](/docs/segment/api/public-api/).

## Getting started

1. From the Segment web app, click **Catalog**, then click **Destinations**.
2. Find the Destinations Actions item in the left navigation, and click it.
3. Click **Configure Qualtrics**.
4. Select an existing Source to connect to Qualtrics (Actions).
5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions in the [Finding your Qualtrics IDs](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds) documentation.

## Destination Settings

| Field         | Description                                                                                                                          | Required | Type     |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------- | -------- |
| API Token     | Qualtrics API token found in your Qualtrics account under "Account settings" -> "Qualtrics IDs."                                     | Yes      | password |
| Datacenter ID | Qualtrics datacenter id that identifies where your qualtrics instance is located. Found under "Account settings" -> "Qualtrics IDs". | Yes      | string   |

## Available Actions

Build your own Mappings. Combine supported [triggers](/docs/segment/connections/destinations/actions/#components-of-a-destination-action) with the following Qualtrics-supported actions:

> \[!NOTE]
>
> Individual destination instances have support a maximum of 50 mappings.

* [Create and/or update contact in XM Directory](#create-andor-update-contact-in-xm-directory)
* [Start a workflow in Qualtrics](#start-a-workflow-in-qualtrics)
* [Upsert contact transaction](#upsert-contact-transaction)

### Create and/or update contact in XM Directory

Create and/or update contact in XM Directory. Updating is handled by contact deduplication in your [directory settings](https://www.qualtrics.com/support/iq-directory/directory-settings-tab/automatic-deduplication/). If deduplication is setup correctly this action will perform UPSERT operations on contacts

Create and/or update contact in XM Directory is a **Cloud** action. The default Trigger is `type = "identify"`

| Field                   | Description                                                           | Required | Type    |
| ----------------------- | --------------------------------------------------------------------- | -------- | ------- |
| Directory ID            | Directory id. Also known as the Pool ID. POOL\_XXX                    | Yes      | STRING  |
| External Data Reference | The external data reference which is a unique identifier for the user | No       | STRING  |
| Email                   | Email of contact                                                      | No       | STRING  |
| Phone number            | Phone number of contact                                               | No       | STRING  |
| First Name              | First name of contact                                                 | No       | STRING  |
| Last Name               | Last name of contact                                                  | No       | STRING  |
| Language                | Language code of the contact                                          | No       | STRING  |
| Contact is unsubscribed | Should the contact be unsubscribed from correspondence                | No       | BOOLEAN |
| Contact embedded data   | Contact embedded data (properties of the contact)                     | No       | OBJECT  |

### Start a workflow in Qualtrics

This action is used to kick off a workflow in Qualtrics

Start a workflow in Qualtrics is a **Cloud** action.

| Field         | Description                                                                                                                                                                                                                                              | Required | Type   |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------ |
| Workflow URL  | Enter the full URL as you see in your Xflow trigger. \[See more details on setting up an xflow trigger and getting the URL.]\(https://static-assets.qualtrics.com/static/integrations-external/twilio\_segment\_event\_webhook\_setup\_instructions.pdf) | Yes      | STRING |
| Event payload | A mapping of key values to send to Qualtrics xflow.                                                                                                                                                                                                      | No       | OBJECT |

### Upsert contact transaction

Add a transaction to a contact in Qualtrics directory. If the contact already exists, add the transaction. If the contact does not exist, create the contact first, then add the transaction record.

Upsert contact transaction is a **Cloud** action. The default Trigger is `type = "track", event = "Transaction Created"`

| Field                      | Description                                                                                                                                                                                                                                                                                                                                           | Required | Type     |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -------- |
| Directory ID               | Directory id. Also known as the Pool ID. POOL\_XXX                                                                                                                                                                                                                                                                                                    | Yes      | STRING   |
| Mailing list ID            | ID of the mailing list the contact belongs too. If not part of the event payload, create / use an existing mailing list from Qualtrics. Will have the form CG\_xxx                                                                                                                                                                                    | Yes      | STRING   |
| Contact ID                 | The id of the contact to add the transaction. if this field is not supplied, you must supply an external data reference, email and/or phone so a look can be performed. If the lookup does not find a contact, one will be created with these fields and including the optionally supplied firstName, lastName, language, subscribed and embeddedData | No       | STRING   |
| External Data Reference    | The external data reference which is a unique identifier for the user. This is only used to search for the contact and if a new contact needs to be created, it is not added to the transaction data.                                                                                                                                                 | Yes      | STRING   |
| Email                      | Email of contact. This is only used to search for the contact and if a new contact needs to be created, it is not added to the transaction data.                                                                                                                                                                                                      | No       | STRING   |
| Phone number               | Phone number of contact. This is only used to search for the contact and if a new contact needs to be created, it is not added to the transaction data.                                                                                                                                                                                               | No       | STRING   |
| First name                 | First name of contact. This is only used if a new contact needs to be created and is not added to the transaction data.                                                                                                                                                                                                                               | No       | STRING   |
| Last name                  | Last name of contact. This is only used if a new contact needs to be created and is not added to the transaction data.                                                                                                                                                                                                                                | No       | STRING   |
| Language                   | Language code of the contact. This is only used if a new contact needs to be created and is not added to the transaction data.                                                                                                                                                                                                                        | No       | STRING   |
| Contact is unsubscribed    | Should the contact be unsubscribed from correspondence. This is only used if a new contact needs to be created and is not added to the transaction.                                                                                                                                                                                                   | No       | BOOLEAN  |
| Contact embedded data      | Contact embedded data (properties of the contact). These are added to the contact only if a new contact needs to be created not added to the transaction.                                                                                                                                                                                             | No       | OBJECT   |
| Date & time of transaction | Date and time of when the transaction occurred.                                                                                                                                                                                                                                                                                                       | No       | DATETIME |
| Transaction data           | Properties of the transaction too add to the users record                                                                                                                                                                                                                                                                                             | No       | OBJECT   |
