Integrating with Amazon Web Services
About Integrating with Amazon Web Services
Amazon Web Services (AWS) is a commonly used cloud computing platform. One of AWS’ services, Amazon EventBridge, can be used as an integration point between AWS and Qualtrics.
Based on events in Amazon EventBridge, you can trigger a Qualtrics workflow to then trigger other tasks, such as sending a survey, a thank you email, or a reward for completing a survey.
Step 1: Setting up a JSON Event
- In Qualtrics, create a new event-based workflow.
- For your event, choose the JSON Event.
- Click Copy URL. Save this URL somewhere so you can reference it later.
Step 2: Creating a Connection in EventBridge
The next step is to create a connection in EventBridge so that data can be passed between AWS and Qualtrics.
- In a new tab, log in to Amazon Web Services and navigate to the Amazon Eventbridge console.
- Navigate to the API destinations.
- In the Connections tab, click Create connection.
- Enter a Connection name so you know what this connection is used for.
- Choose Other for the Destination type.
- For the Authorization type, choose Basic.
- For the Username, enter your Qualtrics username.
- For the Password, enter your Qualtrics account API Key.
- Click on the Invocation Http Parameters to expand them.
- Configure the following fields:
- Parameter: Header
- Key: Content-Type
- Value: application/json
- Click Create.
- In the Connections window, validate that your connection is Authorized.
Step 3: Creating an API Destination in EventBridge
Next, you’ll create an API destination in EventBridge which controls where data is sent. In this case, the API destination is the JSON event URL you copied in Step 1.
- In EventBridge, go to API destinations.
- In the API destinations tab, click Create API destination.
- Enter a Name so you know what this API destination is used for.
- For the API destination endpoint, paste the JSON event URL that you copied in step 1.
- For the HTTP method, select POST.
- If desired, enter an Invocation rate limit per second. This controls the maximum number of times the endpoint can be called per second.
Qtip: Qualtrics supports up to 3000 transactions per minute (50 per second sustained).
- For the Connection, select Use an existing connection.
- Using the dropdown menu, choose the connection you created in step 2.
- Click Create.
- In the API destinations window, check that your API destination is Active.
Step 4: Creating an EventBridge Rule
Rules in EventBridge are used to filter for specific events and patterns. The rules you create will be unique to your organization and use case. For this section, we’ll use the example of creating a rule to filter for new object creation in S3.
- In EventBridge, navigate to the Rules section.
- Click Create rule.
- Give your rule a descriptive Name.
- For the Event bus, choose default.
Qtip: S3 event notifications can only be sent to the default EventBridge bus.
- For the Rule type, choose Rule with an event pattern.
- Click Next.
- For the Event source, choose AWS events or EventBridge partner events.
Qtip: Visit this AWS support page for examples of events you can send to EventBridge. For the example on this page, we assume an object is dropped into an S3 bucket to be picked up and processed inside Qualtrics.
- Select Use pattern form for the Creation method.
- For the Event source, choose AWS services.
- Choose Simple Storage Service (S3) as your AWS service.
- Select Amazon S3 Event Notification for the Event Type.
- Enable Specific event(s) and choose the Object Created event.
- Enable Specific bucket(s) by name and enter your S3 bucket name.
- Click Next.
- Choose EventBridge API destination for the Target type.
- For the API destination, choose Use an existing API destination and then use the dropdown to select the API destination you created in step 3.
- For the Execution role, either create a new role or use an existing one.
- Follow the instructions in the Rules editor to review and finish setting up the rule.
Step 5: Update S3 Bucket Settings
Follow the instructions on this AWS support page to update your S3 bucket to push events to EventBridge.
Step 6: Completing the Workflow
Your AWS and Qualtrics instances are now connected! Once an object is uploaded into S3, an event will be sent to EventBridge, which will then deliver the event into the JSON event in your Qualtrics workflow, starting the workflow. You’ll have full access to the S3 event in the JSON event’s body.
You can then add tasks that will fire as a result of your workflow. See Defining Tasks for more information.