microsoft / powerplatform-qualtrics-api

An OpenAPI demo specification to integrate Qualtrics XM into Microsoft Power Platform

Sample integration for Qualtrics® Surveys into Microsoft Power Platform

This repository contains sample code to demonstrate integration of Qualtrics® survey data and survey events into Microsoft Power Platform. The OpenAPI 2.0 compliant SWAGGER file can be used as the base to create a Microsoft Power Platform custom connector. The OpenAPI 3.0 compliant file is there for reference use into Azure API Management (at this point of time Power Platform does not allow OA 3.0 compliant files)

The sample code implements the following actions on the Qualtrics® API located at https://api.qualtrics.com/ To gain access to the API a Qualtrics account is required.

This sample is provided as-is as a reference and not intended to be used for production purposes

Usage

• Navigate to https://make.powerapps.com.
• Expand Data > Custom Connectors > New Custom Connector > From OpenAPI file > Select the SWAGGER 2.0 compliant file
• Setup icon and other options

Triggers

• When a survey response is submitted (see caution note below)

  Triggers when a response is submitted to a survey. Takes the SurveyID (e.g: SV_123) in the topic field to subscribe to the right survey events.

Actions

• Create contact in mailing list

  POST new contact data to a given Qualtrics directory and mailing list. DirectoryId and MailingListId can be obtained from the Qualtrics API portal.

• Get distributions for survey

  Get distributions for a given survey

• Generate distribution links

  Generate individual links for a given distribution

• Retrieve distribution links

  Retrieve the links generated with Generate distribution links action

• Get event subscriptions

  Get all the registered events. Will return all the events that are registered with a webhook endpoint. See the Qualtrics API documentation for a list of topics that can be subscribed.

• Get survey

  Returns a given survey

• Remove event subscription (see note below)

  Dummy

Caution with the trigger

The trigger definition (When a survey response is submitted) registers a webhook endpoint in the Qualtrics API. Microsoft mandates that any trigger that creates a webhook includes a location header to indicate to Power Platform how to de-register the trigger. The LOCATION header points to a DELETE action. As of the time of the publication of this file the Qualtrics API does not provide a DELETE endpoint. The DELETE action (Remove event subscription) is only a dummy to make the specification work in PowerPlatform. This means that any registered webhook endpoint will continue to receive data until the respective survey is deleted.

The result in Microsoft Power Automate

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.

powerplatform-qualtrics-api's Issues

OpenAPI definition - requestbody schema $ref points to requestBody object not schema object

powerplatform-qualtrics-api/Qualtrics Connector Spec - OpenAPI 3.0.json

Line 97 in 27034bf

"$ref": "#/components/requestBodies/CreateDistributionLinks"

Either the $ref should be at the requestBody level, or the value of this $ref should traverse down far enough to point to a schema object.

See also

"$ref": "#/components/requestBodies/CreateContactInMailingList",
"$ref": "#/components/requestBodies/SubscribeToEventBody"