Overview
REST APIs for integrating with Confetti.
Confetti exposes two REST APIs, each with its own authentication method.
Looking to generate reports? Start with the MCP server — connect an AI assistant and ask in plain language. Use the server-to-server API below only when you need automated pipelines or engagement funnel metrics.
Public API
Used by the widget to fetch surveys and submit responses. Authenticated with your team's publishable key (x-cfti-pk header).
Server-to-server API
Backend integrations authenticated with a secret API key (Authorization: Bearer). Read responses, engagement stats, and score distributions.
Which one should I use?
| Public API | Server-to-server API | |
|---|---|---|
| Audience | Browser / widget | Your backend |
| Credential | Publishable key | Secret API key |
| Sent as | x-cfti-pk header | Authorization: Bearer <key> |
| Safe to expose in client code | Yes | No |
| Status | Available | Available |
Integration guides
| Guide | When to use |
|---|---|
| MCP reporting | Ad-hoc reports, CSAT summaries, exploring responses in conversation |
| API reporting | Scheduled pipelines, data warehousing, engagement stats |
| Webhooks | Real-time routing of each new response to Slack or a helpdesk |
Machine-readable spec
The full OpenAPI 3.1 specification is available at
/openapi.json — useful for code generation, API clients, and
AI tools.
Was this page helpful?