Integrations Overview¶
Canviq provides several ways to integrate feedback collection into your product. Choose the approach that fits your stack and use case.
Integration Paths¶
| Path | Best for | Time to set up |
|---|---|---|
| Quick Start | Any integration — start here | 5 minutes |
| Embed (iframe) | Web apps that want the full Canviq board inside their product | 10 minutes |
| Submit via API | Apps that collect feedback in their own UI and forward to Canviq | 30 minutes |
| iOS / Android | Native mobile apps using SFSafariViewController or Custom Tabs | 1–2 hours |
| Bot / CI Pipeline | Automated provisioning, multi-tenant setup, internal tooling | varies |
| Webhooks | React to Canviq events in your own systems | 30 minutes |
Authentication Overview¶
All API calls use one of two credential types:
-
Session cookies — For browser-based flows where users interact directly with the Canviq board. Canviq's magic link auth handles session management. No API key required.
-
Org API keys (
pk_org_live_...) — For server-to-server calls, SDK integrations, and CI pipelines. Generate keys from Settings → API Keys. Keys are scoped at creation time.
See Authentication for the full scope reference and key management guide.
Before You Begin¶
You'll need:
- A Canviq account and organization — sign up here
- Your board URL:
https://canviq.app/{your-slug} - An org API key (for server-side integrations) — generate from Settings → API Keys
!!! tip "Not sure which path is right for you?" Start with Quick Start. It covers the fastest path to your first submission.
Status¶
Some integration APIs are actively being built. See the implementation tracker below.
| Feature | Status |
|---|---|
| Public board embed (iframe) | ✅ Available |
| Submit via API (org API key) | 🔧 In progress |
| Bot org provisioning | 🔧 In progress |
| Trusted redirect origins (iOS/Android) | 🔧 In progress |
| Authenticated embed tokens | 📋 Planned |
| Webhooks | 📋 Planned |
Need Help?¶
- Email [email protected]