Quickstart
Create an API key, make your first call, and receive your first event — in five minutes
Five minutes from zero to your first API call and your first live event. You need an organization on the Pro plan (or higher) and admin rights.
1. Create an API key
- Open Settings → Integrations in your WinFactor dashboard.
- In the API keys section, enter a name (e.g.
quickstart) and click Create key. - Copy the
wf_live_…key now — it is shown exactly once.
export WINFACTOR_KEY="wf_live_..." # paste your key
export WINFACTOR_URL="https://app.winfactor.app"2. Make your first call
Ask the API who you are:
curl -s "$WINFACTOR_URL/api/v1/organization" \
-H "Authorization: Bearer $WINFACTOR_KEY" | jq{
"id": "org_2abc…",
"name": "Window Works Inc",
"slug": "window-works",
"locale": "en",
"unitSystem": "imperial",
"currency": "USD",
"plan": "pro",
"externalPricingEnabled": false
}List your most recent submissions:
curl -s "$WINFACTOR_URL/api/v1/submissions?limit=5" \
-H "Authorization: Bearer $WINFACTOR_KEY" | jq '.data[].customer.name'3. Receive your first event
Your organization's ActivePieces project is already wired up (Settings → Integrations → Workflow Automation). Every WinFactor event arrives at your webhook as JSON:
{
"version": "1.0",
"event": "submission.created",
"timestamp": "2026-06-11T14:03:22.000Z",
"organization": { "id": "org_2abc…", "name": "Window Works Inc", "slug": "window-works" },
"data": {
"submission": { "id": "k57…", "createdAt": 1781100202000 },
"customer": { "name": "Jane Doe", "email": "[email protected]" },
"template": { "id": "k12…", "name": "2-panel Lift-Slide Door" },
"pricing": { "source": "base" }
}
}Submit a test configuration through one of your template links and watch it arrive. The full payload shapes are in the events catalog.
4. Go deeper
- Turn on live pricing events and adjust prices while customers configure: Configuration sessions and the ActivePieces recipe.
- Sync submissions and quotes into your CRM: CRM integration guide.
- Verify webhook authenticity: Webhook signatures.
- Browse every endpoint: API reference or the OpenAPI spec.