Skip to content

Commit bc6d153

Browse files
carlmleemarkzegarelli
carlmlee
and
markzegarelli
authored
Adding Qualtrics destination documentation (#3450)
* Adding Qualtrics destination documentation * Set id and added private metadata Co-authored-by: markzegarelli <[email protected]>
1 parent c4d1103 commit bc6d153

File tree

3 files changed

+286
-1
lines changed

3 files changed

+286
-1
lines changed

‎.github/styles/Vocab/Docs/accept.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ param(:?s)
9292
Pardot
9393
performant
9494
Preact
95+
Qualtrics
9596
Rokt
9697
Selligent
9798
Shopify

‎src/_data/catalog/destinations_private.yml‎

Lines changed: 237 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# AUTOGENERATED FROM PUBLIC API. DO NOT EDIT
2-
# destination data last updated 2022-08-25 with Pardot (Actions)
2+
# destination data last updated 2022-09-06 with Qualtrics
33
items:
44
- id: 54521fd525e721e32a72ee8e
55
name: AdRoll
@@ -2215,3 +2215,239 @@ items:
22152215
dynamic: false
22162216
allowNull: false
22172217
presets: []
2218+
- id: 62e17e6f687e4a3d32d0f875
2219+
display_name: Qualtrics
2220+
name: Qualtrics
2221+
slug: actions-qualtrics
2222+
previous_names:
2223+
- Qualtrics
2224+
website: http://www.segment.com
2225+
status: PRIVATE_BETA
2226+
logo:
2227+
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
2228+
mark:
2229+
url: https://cdn.filepicker.io/api/file/jrbUXsZDQ708akn3cVyZ
2230+
methods:
2231+
track: true
2232+
pageview: true
2233+
identify: true
2234+
group: true
2235+
alias: true
2236+
platforms:
2237+
browser: true
2238+
mobile: false
2239+
server: true
2240+
components: []
2241+
browserUnbundlingSupported: false
2242+
browserUnbundlingPublic: false
2243+
replay: false
2244+
settings:
2245+
- name: apiToken
2246+
type: string
2247+
defaultValue: ''
2248+
description: >-
2249+
Qualtrics API token found in your Qualtrics account under "Account
2250+
settings" -> "Qualtrics IDs."
2251+
required: true
2252+
label: API Token
2253+
- name: datacenter
2254+
type: string
2255+
defaultValue: ''
2256+
description: >-
2257+
Qualtrics datacenter id that identifies where your qualtrics instance
2258+
is located. Found under "Account settings" -> "Qualtrics IDs".
2259+
required: true
2260+
label: Datacenter ID
2261+
actions:
2262+
- id: rMsycYYBB1vzGZv3ATE8ks
2263+
name: Add / Update Contact in XMD
2264+
slug: addContactToXmd
2265+
description: Add or update contact in XMD
2266+
platform: CLOUD
2267+
hidden: false
2268+
defaultTrigger: type = "identify"
2269+
fields:
2270+
- id: gzXtk2s9vPxuFjymeyeCmr
2271+
sortOrder: 0
2272+
fieldKey: directoryId
2273+
label: Directory ID
2274+
type: STRING
2275+
description: Directory id. Also known as the Pool ID. POOL_XXX
2276+
placeholder: ''
2277+
defaultValue:
2278+
'@path': $.traits.directoryId
2279+
required: true
2280+
multiple: false
2281+
choices: null
2282+
dynamic: false
2283+
allowNull: false
2284+
- id: ssmexAbNCQ3xuxr5B7n2DN
2285+
sortOrder: 1
2286+
fieldKey: extRef
2287+
label: External Data Reference
2288+
type: STRING
2289+
description: >-
2290+
The external data reference which is a unique identifier for the
2291+
user
2292+
placeholder: ''
2293+
defaultValue:
2294+
'@path': $.userId
2295+
required: false
2296+
multiple: false
2297+
choices: null
2298+
dynamic: false
2299+
allowNull: false
2300+
- id: mEgJZ5LVvDmdHYwrm1BjMQ
2301+
sortOrder: 2
2302+
fieldKey: email
2303+
label: Email
2304+
type: STRING
2305+
description: Email of contact
2306+
placeholder: ''
2307+
defaultValue:
2308+
'@if':
2309+
exists:
2310+
'@path': $.email
2311+
then:
2312+
'@path': $.email
2313+
else:
2314+
'@path': $.traits.email
2315+
required: false
2316+
multiple: false
2317+
choices: null
2318+
dynamic: false
2319+
allowNull: false
2320+
- id: 5AwF7aTcLs7qLzKQYXiYcS
2321+
sortOrder: 3
2322+
fieldKey: phone
2323+
label: Phone number
2324+
type: STRING
2325+
description: Phone number of contact
2326+
placeholder: ''
2327+
defaultValue:
2328+
'@path': $.traits.phone
2329+
required: false
2330+
multiple: false
2331+
choices: null
2332+
dynamic: false
2333+
allowNull: false
2334+
- id: bGxcFVRe2ZHXHAqXWb9jFj
2335+
sortOrder: 4
2336+
fieldKey: firstName
2337+
label: First Name
2338+
type: STRING
2339+
description: First name of contact
2340+
placeholder: ''
2341+
defaultValue:
2342+
'@path': $.traits.firstName
2343+
required: false
2344+
multiple: false
2345+
choices: null
2346+
dynamic: false
2347+
allowNull: false
2348+
- id: agkd786Quy8ovJCVe2QYzL
2349+
sortOrder: 5
2350+
fieldKey: lastName
2351+
label: Last Name
2352+
type: STRING
2353+
description: Last name of contact
2354+
placeholder: ''
2355+
defaultValue:
2356+
'@path': $.traits.lastName
2357+
required: false
2358+
multiple: false
2359+
choices: null
2360+
dynamic: false
2361+
allowNull: false
2362+
- id: eXvgHoRMcQG8u4wofVgAaA
2363+
sortOrder: 6
2364+
fieldKey: language
2365+
label: Language
2366+
type: STRING
2367+
description: Language code of the contact
2368+
placeholder: ''
2369+
defaultValue:
2370+
'@if':
2371+
exists:
2372+
'@path': $.traits.language
2373+
then:
2374+
'@path': $.traits.language
2375+
else: EN
2376+
required: false
2377+
multiple: false
2378+
choices: null
2379+
dynamic: false
2380+
allowNull: false
2381+
- id: t6u7Jrncd2yGaj69WHiiHV
2382+
sortOrder: 7
2383+
fieldKey: unsubscribed
2384+
label: Contact is unsubscribed
2385+
type: BOOLEAN
2386+
description: Should the contact be unsubscribed from correspondence
2387+
placeholder: ''
2388+
defaultValue: false
2389+
required: false
2390+
multiple: false
2391+
choices: null
2392+
dynamic: false
2393+
allowNull: false
2394+
- id: kj2kShh6ZdchL29q3y7Wp9
2395+
sortOrder: 8
2396+
fieldKey: embeddedData
2397+
label: Contact embedded data
2398+
type: OBJECT
2399+
description: Contact embedded data (properties of the contact)
2400+
placeholder: ''
2401+
required: false
2402+
multiple: false
2403+
choices: null
2404+
dynamic: false
2405+
allowNull: false
2406+
- id: u3JwUn6SECofbhY2y7FThX
2407+
name: Trigger workflow in xflow
2408+
slug: triggerXflowWorkflow
2409+
description: This action triggers a workflow in Qualtrics xflow
2410+
platform: CLOUD
2411+
hidden: false
2412+
defaultTrigger: null
2413+
fields:
2414+
- id: 4Kb3t8a8Tte1hLR1p6fdc6
2415+
sortOrder: 0
2416+
fieldKey: workflowUrl
2417+
label: Workflow URL
2418+
type: STRING
2419+
description: >-
2420+
Enter the full URL as you see in your Xflow trigger. See more
2421+
details on setting up an xflow trigger and getting the URL here.
2422+
placeholder: ''
2423+
required: true
2424+
multiple: false
2425+
choices: null
2426+
dynamic: false
2427+
allowNull: false
2428+
- id: eTBjVC88eeFDtT7nUjW5Fu
2429+
sortOrder: 1
2430+
fieldKey: eventPayload
2431+
label: Event payload
2432+
type: OBJECT
2433+
description: A mapping of key values to send to Qualtrics xflow.
2434+
placeholder: ''
2435+
defaultValue:
2436+
event:
2437+
'@path': $.event
2438+
type:
2439+
'@path': $.type
2440+
userId:
2441+
'@path': $.userId
2442+
properties:
2443+
'@path': $.properties
2444+
traits:
2445+
'@path': $.traits
2446+
context:
2447+
'@path': $.context
2448+
required: false
2449+
multiple: false
2450+
choices: null
2451+
dynamic: false
2452+
allowNull: false
2453+
presets: []

‎src/connections/destinations/catalog/actions-qualtrics/index.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
title: Qualtrics Destination
3+
hide-boilerplate: true
4+
hide-dossier: true
5+
id: 62e17e6f687e4a3d32d0f875
6+
private: true
7+
---
8+
9+
<!-- This template is meant for Actions-based destinations that do not have an existing Classic or non-Actions-based version. For Actions Destinations that are a new version of a classic destination, see the doc-template-update.md template. -->
10+
11+
{% include content/plan-grid.md name="actions" %}
12+
13+
<!-- Include a brief description of the destination here, along with a link to your website. -->
14+
15+
[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
16+
17+
<!-- This include describes the requirement of A.js 2.0 or higher for Actions compatibility, and is required if your destination has a web component. -->
18+
19+
{% include content/ajs-upgrade.md %}
20+
21+
<!-- In the section below, explain the value of this actions-based destination. If you don't have a classic version of the destination, remove this section. -->
22+
23+
## Benefits of Qualtrics (Actions)
24+
25+
Qualtrics (Actions) provides the following benefits:
26+
27+
- **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
28+
- **Streamlined configuration**. Qualtrics destination maps your event data to the Qualtrics API & Qualtrics xflow (workflows) out of the box
29+
30+
<!-- The section below explains how to enable and configure the destination. Include any configuration steps not captured below. For example, obtaining an API key from your platform and any configuration steps required to connect to the destination. -->
31+
32+
## Getting started
33+
34+
1. From the Segment web app, click **Catalog**, then click **Destinations**.
35+
2. Find the Destinations Actions item in the left navigation, and click it.
36+
3. Click **Configure Qualtrics**.
37+
4. Select an existing Source to connect to Qualtrics (Actions).
38+
5. To authenticate, enter your API key & Datacenter ID. To locate your API key & Datacenter ID, follow in the instructions found [here](https://api.qualtrics.com/ZG9jOjg3NjYzNQ-finding-your-qualtrics-i-ds)
39+
40+
<!-- The line below renders a table of connection settings (if applicable), Pre-built Mappings, and available actions. -->
41+
42+
{% include components/actions-fields.html %}
43+
44+
<!--
45+
Additional Context
46+
47+
Include additional information that you think will be useful to the user here. For information that is specific to an individual mapping, please add that as a comment so that the Segment docs team can include it in the auto-generated content for that mapping.
48+
-->

0 commit comments

Comments
 (0)