Integration planning
Choose a workflow, make a key, and know which door it opens.
Choose the workflow first
| You need to | Start with |
|---|---|
| Bring a contact list | The REST API: add people, prepare their links, download the links. |
| Get a study's links into another tool | The REST API's study-links call, which returns the study link and the test link. |
| Create studies, read fieldwork and results from an assistant | The MCP server with an API key. |
| Send people from another survey or panel | An agreed respondent entry and outcome contract with the team. |
| Give an assistant the manual | llms.txt and the plain Markdown pages. |
Every door takes the same API key, made by any member in Settings. Research and Studio have different study and respondent runtimes: Studio's legacy REST, smart-link and webhook examples are not a contract for Research.
Events and connectors
Confirm the actual events, payloads, authentication, retries and reconciliation rules before relying on automatic delivery. A legacy interview.completed webhook does not establish that a Research response or report event is delivered.
A connector shown in the interface may require a separate account connection or activation. Confirm the source's usable filters, contact permissions, cost and current readiness. The team can review custom requirements.
Test the contract
- Use an isolated test workspace or agreed synthetic records.
- Check a wrong key, a revoked key, a read key on a write, and a study from another workspace.
- Test duplicate requests and recoverable failures.
- Verify participant identifiers and every relevant outcome.
- Reconcile a result and a downloaded file against the intended snapshot.
- Record which checks were local, hosted and provider-accepted.
Send a useful integration brief
Describe the system you use, the operation you need, expected volume, fields, formats, workspace boundaries and required timing. Include security and data-handling requirements.
Send the brief to hello@underheard.ai. The public docs can be shared freely; keys and private respondent links go through the agreed secure channel.