Skip to content

Account Setup

!!! info "TL;DR" Canviq is a hosted SaaS product at canviq.app. There is nothing to install. Sign up, connect your product via the JavaScript SDK or REST API, and start collecting PMF survey responses within minutes.

Sign Up

Navigate to canviq.app and click Get Started.

1. Enter your work email address
2. Click "Send Magic Link"
3. Check your inbox for the login link
4. Click the link to complete sign-up

Your account is created automatically on first login. No password, no credit card required to start.

!!! note Canviq uses passwordless magic link authentication. GitHub OAuth is also supported for developer accounts.

Create Your Organization

After signing in for the first time, you will be prompted to create an organization. This is the container for your PMF surveys, respondents, and analytics.

1. Enter your product name (e.g., "Acme App")
2. Enter your company name
3. Click "Create Organization"

You can invite team members and configure branding after setup.

Connect Your Product

Choose the integration method that fits your stack.

Install the Canviq SDK in your web app:

npm install @canviq/sdk

Initialize with your public API key:

import { Canviq } from '@canviq/sdk'

Canviq.init({
  apiKey: 'cvq_pub_your_key_here',
  userId: currentUser.id, // your user's unique ID
  userEmail: currentUser.email, // used for survey delivery
  userProperties: {
    plan: currentUser.plan, // optional: used for targeting
    createdAt: currentUser.createdAt,
  },
})

The SDK handles survey display, targeting logic, and response submission automatically. See SDK Integration for full configuration options.

REST API

If you prefer a server-side or non-JavaScript integration, use the REST API directly:

curl -X POST https://canviq.app/api/surveys/responses \
  -H "Authorization: Bearer cvq_sk_your_secret_key" \
  -H "Content-Type: application/json" \
  -d '{
    "surveyId": "your-survey-id",
    "respondentId": "user-123",
    "respondentEmail": "user@example.com",
    "answers": [...]
  }'

See the API Reference for all endpoints.

Get Your API Keys

API keys are in the Canviq dashboard under Settings > API Keys.

Key type Prefix Usage
Public key cvq_pub_ Client-side SDK initialization (safe to expose)
Secret key cvq_sk_ Server-side API calls (never expose in the browser)

Warning

client-side code. Rotate keys immediately in the dashboard if they are compromised.

Verify the Connection

After initializing the SDK, open your product in a browser and check the Canviq dashboard > Settings > SDK Status. You should see:

  • Connection status: Connected
  • Last seen: a recent timestamp
  • SDK version: the installed version

If the status shows Not connected, check that apiKey in your Canviq.init call matches the public key in the dashboard.

Next Steps

Questions? Email support@canviq.app.