Integrations & API
Build research workflows around a question type manifest, readiness dry-run validation, scoped API keys, and reviewed data handoffs.
API keys ship with Professional; expanded Insight API endpoints are in private beta.
Developer-First Platform
Capability Manifest
Discover supported question types and coverage by builder, respondent, analytics, export, and agent use
Readiness Dry-Run
Validate proposed survey JSON before creating records or fielding a draft
Scoped API Keys
Create, rotate, revoke, and audit dashboard-managed keys — API keys ship with Professional
Distribution Links
Route respondents through tracked short links, email campaigns, and embeds with workspace permissions
Contract-First API Workflow
Start with public discovery and validation before requesting private beta write access.
const response = await fetch('/api/capabilities/question-types');
const manifest = await response.json();
const supportedForAgents = manifest.questionTypes.filter((question) =>
question.capabilities.aiAgent === 'supported'
);
console.log(manifest.version, supportedForAgents.map((question) => question.id));const response = await fetch('/api/capabilities/survey-readiness', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
title: 'Concept preference study',
questions: [
{
type: 'single_choice',
text: 'Which concept would you be most likely to try?',
options: [{ text: 'Concept A' }, { text: 'Concept B' }]
}
]
})
});
const readiness = await response.json();
if (readiness.status === 'blocked') {
throw new Error(readiness.issues.map((issue) => issue.message).join('\n'));
}// Scoped API keys ship with Professional plans and are managed from
// the dashboard. Expanded Insight API endpoints (write and sync
// workflows) are in private beta - request access for those.
const headers = {
Authorization: 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
};Destinations
Three destinations ship today. The rest are planned, and are listed here so the gap is visible rather than implied.
Slack
Channel notifications for responses and completions
HubSpot
Contact and company property sync
Salesforce
Field mapping onto CRM objects
Airtable
Planned — no connector today
PlannedGoogle Sheets
Planned — no connector today
PlannedMailchimp
Planned — no connector today
PlannedNotion
Planned — no connector today
PlannedIntercom
Planned — no connector today
PlannedOutbound webhooks and the REST API cover destinations without a first-party connector. Zapier support is planned and the Zapier app is not yet published.
Reviewed Data Handoffs
Move approved survey outputs into downstream research and analytics workflows
CSV
Export review-ready rows
JSON
Preserve structured question metadata
Reports
Share reviewed chart narratives
Private beta
Scope custom data handoffs
Security Review Points
API Key Lifecycle
Create, rotate, revoke, and audit keys from the dashboard
Least-Privilege Scope
Request only the read or write workflows needed for the integration
Operational Review
Confirm retry, logging, and data-retention needs during onboarding
A production integration should start by fetching the manifest, validating a generated draft, reviewing warnings, and only then requesting private beta access for write or sync workflows.
Frequently Asked Questions
What authentication methods are supported?
Capability endpoints are public discovery routes. Authenticated workflows use scoped API keys that can be created, rotated, or revoked from the dashboard - API keys ship with Professional plans.
Are there rate limits?
Yes - every API key carries a per-minute rate limit set by your plan, with higher limits on Enterprise. Private beta endpoint limits are confirmed during onboarding.
Can I validate generated survey drafts?
Yes. Use the question type manifest to select supported question ids, then POST the draft to the survey readiness endpoint before creating or publishing it.
How should custom integrations start?
Start with exports, the capability manifest, and readiness dry-run validation. For write workflows or system-to-system sync, request private beta access.
The API behind these integrations
The capability manifest, readiness dry-run, and scoped API keys on this page are all part of the Insight API. API keys ship with Professional; expanded Insight API endpoints are in private beta.
Ready to Build?
API keys ship with Professional; expanded Insight API endpoints are in private beta.
