Setting up an External Survey Link Question

Overview

This guide walks you through the steps required to configure a question using External Survey Link question in QualBoard.

Required Parameters from External Systems

To initiate the survey correctly, the external system must pass the following query string parameters:

• eventId – Unique identifier for the event
• userId – Unique identifier for the user
• questionId – Unique identifier for the question
• ESL API Key (X-External-Redirect) – Must be hardcoded into the survey. This key remains the same across the entire project.

Optional Parameters

These may be included based on project needs:

• sesskey – Useful for platform-specific workflows
• External ID – Profile field identifier
• Group Tags

Survey Initialization Requirements

The target platform must:

1. Capture the following from the query string:
   • eventId
   • userId
   • questionId
   • sesskey (if used)
2. Store these values at the start of the survey. 

Marking Completion in QualBoard

Once the survey is completed, the external platform must notify QualBoard by making a request to:

/api/events/{eventId}/questions/{questionId}/external-redirect-callback

• This can be a GET or POST request depending on platform capabilities.
• The request must include:
  • userId
  • X-External-Redirect (API Key)

Note: This call marks the response as complete in QualBoard but does not close the external platform screen. You must either:

• Close the tab manually, or
• Redirect the user back to QualBoard for final confirmation.

Example of callback confirmation:

Testing the Callback

You can test the callback by pasting the following URL into a browser and replacing the placeholders with actual values:

https://api.qualboard.com/api/events/${eventId}/questions/${questionId}/external-redirect-callback?userId=${userId}&X-External-Redirect=[hard_coded_api_key]

If you have any questions or need assistance, please email support@qualboard.com.