X

Overview

Events

Actions

Home > Application Reference > Qualtrics

Jump to a Section

Overview

Authorizing an Account

The first time you add a Qualtrics card to a Flow, you need to set up a configuration for that Channel. Setting up a configuration will allow you to connect the Designer to your Qualtrics account, save the data, and reuse that configuration next time you build a Flow with this card. That way, you don’t have to sign in every time you want to build a Flow with this Channel. After you’ve set up one configuration, you can choose to use that configuration again, or set up a new one.

You can set up and save multiple configurations and share them with your teammates. Here’s how to set up a new configuration in Qualtrics:

  1. Add the Qualtrics card you would like to use to your Flow. If you already have configurations set up, you will have to select Add Account to create a new configuration. If you don’t have any configurations set up, you will automatically be taken to the next step.
  2. Name your configuration. Choose something unique, since you may need to be able to tell multiple configurations apart in the future.
  3. Please fill the field according to your information.
    1. Data Center ID : This could be found as a subdomain in your Qualtrics instance For Example: us1.qualtrics.com -> The ID is us1.
    2. API Token : This could be found in usersetting -> Qualtrics ID -> API -> token, full instructions can be found here.
    3. Username : What you use to login into your Qualtrics instance.
  4. Click Authorize.

    Events

    • New Response

      Begin a Flow whenever there is a new response to a survey in Qualtrics. Additional fields may be available depending on the account and options you choose.

      Note: This feature is currently non-functional on the Azuqua platform. The endpoint required to establish a secure webhook connection upon activating a Flow is experiencing an outage. Details about the status of this outage may be found on this Qualtrics community forum thread.

      Until this issue is resolved, users will be unable to add the New Response event card to Flows. Existing Flows with the New Response event card will remain inactivate inside their original folders and users will not be able to activate them.

      Options:

      • Survey (list): Drop down menu of survey within your Qualtrics account.

      Outputs:

      • Metadata
        • Response ID (text): Unique ID for the new response.
        • Recipient ID (text): Unique ID for the recipient of the new response.
        • Response Event Context (text):
        • Response Set (text):
        • Status (text): Status of response (Eg. Completed…).
        • Start Date (text): Date response was created.
        • End Date (text): Date response was finished being written (dependent on status of response).
        • Finished? (true/false): If true, response is finished.
      • Recipient
        • Name (text): Name of recipient.
        • External Reference (text): External website link associated with recipient.
        • Email Address (text): Email address of recipient.
        • IP Address (text): A unique string of numbers separated by periods that identifies each computer using the Internet Protocol to communicate over a network.

    Actions

    • Add User to Group

      Add a user to a group using their user ID

    • Create Contact

      Create a new contact and add them to a directory. Available to Target Audience users only.

    • Create Contact in Mailing List

      Create a new contact and add them to a list.

    • Create Group

      Create a new user group

    • Create User

      Create a new user using their email

    • Custom API Action

      Make a custom HTTP request to the Qualtrics API.

      Qualtrics API documentation: https://www.qualtrics.com/support/integrations/api-integration/overview/.

      • GET: retrieves data from a web server based on your parameters. GET requests a representation of the specified resource, and if successful will receive a 200 OK response message with the requested content. Additional documentation here.

      • POST: sends data to a web server based on your parameters. POST requests include actions like uploading a file. Multiple POST’s may result in a different outcome than a single POST, so you should be cautious about unintentionally sending multiple POST’s. Additional documentation here.

      • PUT: sends data to a location in the web server based on your parameters. PUT requests include actions like uploading a file. The difference between a PUT and POST is that PUT is idempotent, meaning that the result of a single successful PUT is the same as many identical PUT’s. Additional documentation here.

      • DELETE: deletes the specified resource from the web server based on your parameters (if the resource exists). Additional documentation here.

      Input Fields

      • Request

        • Relative URL (string) - Relative request URL. E.g. - If the full API URL is https://YOURORG.qualtrics.com/API/v3/surveys/SV_ID, then the Relative URL would be SV_ID.

          Example: SV_ID

        • Query (object) - Query parameters for the request.

          Example: {"Token":"5"}

        • Headers (object) - Headers for the request.

          Example: {"Accept":"application/json"}

        • Body (object) (only for POST, PUT, and DELETE) - Body of the request.

          Example: {"foo": "automation, "bar": "integration"}

      Output Fields

      • Response
        • Status Code (number) - The status code of the HTTP response. Here is a list of all status codes.
        • Headers (object) - The response headers. A more detailed context for the response/status code that doesn’t relate to the output body. Not all headers that appear in a response header are response headers, meaning that some are unlikely to be useful to you.
        • Body (object) - The response body. Depending on the HTTP request you chose in Options, you may receive some data back. That data, such as the data from a GET request, will be contained in this Body object.

    • Delete Contact

      Delete a contact using their contact ID. Available to Target Audience users only.

    • Delete Contact from Mailing List

      Delete a contact using their contact ID.

    • Delete Group

      Delete a group using the group ID

    • Delete Survey

      Delete a survey using the survey ID

    • Delete User

      Delete a user using their user ID

    • Export Responses

      Export Responses.

    • Import Survey

      Import a survey from a file

    • Read All Surveys

      Read a list of all surveys in your account

    • Read Contact

      Read a contact from a directory using their contact ID. Available to Target Audience users only.

    • Read Contact from Mailing List

      Read a contact from a list using their contact ID.

    • Read Group

      Read information about a user group using the group ID

    • Read Mailing List Contacts

      Read all contacts on a contact list

    • Read Mailing Lists

      Read all of the contact lists in your instance.

    • readResponse - Qualtrics

      Reads responses stored in Qualtrics.

      Note: Additional fields may be available depending on the account and options you choose.

      Options:

      • Survey (list): Drop down menu of survey within your Qualtrics account.

      Inputs:

      • Response
        • Response ID (text): Identification code of response.

      Outputs:

      • Metadata
        • Response Set (text):
        • Status (text): Status of response (Eg. Completed…)
        • Start Date (text): Date response was created.
        • End Date (text): Date response was finished being written (dependent on status of response)
        • Finished? (true/false): If true, response is finished.
      • Recipient
        • Name (text): Name of recipient.
        • External Reference (text): External website link associated with recipient.
        • Email Address (text): Email address of recipient.
        • IP Address (text): A unique string of numbers separated by periods that identifies each computer using the Internet Protocol to communicate over a network.

    • Read Survey

      Read information about a survey using the survey ID

    • Read User

      Read information about a user using their user ID

    • Remove User from Group

      Remove a user from a group using their user ID

    • Update Contact

      Update a contact in a directory using their contact ID. Available to Target Audience users only.

    • Update Contact in Mailing List

      Update a contact in a list using their contact ID.

    • Update Group

      Update information about a user group

    • Update Survey

      Update information about a survey using the survey ID

    • Update User

      Update a user using their user ID