Capture feedback sent from TestFairy into Centercode
TestFairy is a mobile testing platform that provides companies with app distribution, with detailed video recordings, logs, and crash reports of mobile sessions.
Testfairy can be configured to send feedback to the Centercode platform by using Centercode’s External Feedback tool. This API integration tool is designed to be flexible enough to receive data from any API capable third parties and map it into Centercode’s feedback forms. This increased tester engagement and removes potential friction by enabling your users to submit valuable feedback from Testfairy directly into Centercode.
In this guide, you will:
- Create (or identify an existing) API Key in Centercode
- Configure an External Source to receive feedback in Centercode
- Identify data to be captured from TestFairy and sent to Centercode
In order to configure both sides of this integration, you will need:
- Access to an existing API Key or Community Manager access to create a new one
- Project Manager access in the project of your choice (or your project template)
- Knowledge of TestFairy's system or an internal technical resource for TestFairy
1. Creating an API Key
From Centercode, the first step in any API integration is to ensure that you have an API Key available within your Centercode Community. API Keys are used to track and control how API endpoints are accessed and can be leveraged by multiple simultaneous API integrations. If one is already created and available for use, you may continue past this step.
If necessary, create a Community API Key by following steps outlined here.
2. Configuring External Feedback Sources
The External Feedback Source tool is located within a Feedback Type’s settings. To begin, you’ll need to navigate to the External Sources section of your desired Feedback type. Here, you’ll configure the data you want to be captured. We’ll start this example with Bug Reports. Please repeat the below steps in as many Feedback Types as necessary.
From your Project homepage:
- Click Project Tools
- Click Feedback Types
- Hover over your desired Feedback Type (Bug Reports) & click Modify
- Click External Sources
- Click Create an External Source - you’re now at the External Source creation screen to designate a way to receive external feedback to the specified feedback type. At this point, technical help may be necessary - please work with a developer (and/or Centercode).
From the External Sources creation page:
- Create an (internally-facing) Name
- Provide a simple Key to help identify this External Source (ex: “appcrashlog” - detailed below)
- Select the appropriate Workflow state for new feedback created via this source (typically “New”)
- These fields define the Team submitting feedback and the Status in which it comes in
- Select Default Submitter for new feedback from this source
- Note: leaving this field blank will mark the Submitter parameter as required, matching on email address - that field must be a supplied Parameter by the incoming data and must be an existing email address in your Project
- Configure your Incoming Fields, mapping the Centercode Field with their matching incoming Parameters (detailed below)
- Select the appropriate API Key from the list (if more than one is available)
- Copy / Save your API Endpoint URL - you’ll need it later!
- Click Submit
- Your Key can be a short, descriptive entry to separate this integration from other functions that use the same Community API key for easier use.
- Incoming Fields map Parameters defined in your third-party system to the Centercode feedback form. Below is an example of incoming JSON data. Here you can see it matching to these fields exactly. See the example image below.
- Single Choice, Multiple Choice, and Rating Scale values passed to Centercode via parameter must match the selection options on the Feedback Form exactly.
- The Workflow section leverages the existing Workflow configured for your Feedback Type
- Under Workflow, choosing No Selection here will mark the Status parameter as required - that field must be a supplied Parameter by the incoming data. This means that your system is providing the custom status field of the incoming feedback. The Status your system is providing must be one existing in your Centercode feedback form.
- When External Source is created without an otherwise matching Submitter, it is attributed to the Default Submitter, which is an existing user account of your choosing.
- Advanced Options allow you to decide if your External Source should trigger existing Feedback Automation or Workflows (including External Destinations)
Configuring TestFairy to Send Feedback Data to Centercode
After completing the above instructions to prepare Centercode to accept External Feedback, you’ll need to configure TestFairy to send data to Centercode.
- Open your TestFairy account Preferences and create a new webhook
2. Name the webhook "Centercode", enter the Centercode endpoint URL, check the "feedback" checkbox, and submit.
The JSON Payload
The JSON payload determines the data that will be sent from TestFairy to Centercode’s External Feedback Source. The fields on the left (e.g. “submitter” and “summary”) are the Parameters you’re matching to the External Feedback’s Parameters. The fields on the right are the values that will be mapped to every converted piece of feedback. The below example simulates a third-party source via Postman.
Common Troubleshooting Scenario
When utilizing this integration through your third-party system, you may encounter a 400 status code, which indicates failure. In this scenario, submitter user account may be invalid, whether feedback is attempting to be submitted by an email address that doesn’t exist within the project or invalid submitter parameters are configured:
"description": "The feedback submission could not be saved.",
"description": "A valid submitter is required."