For developers
API endpoints, webhook payloads, embed options, and the analytics event schema.
This section is for the more technical buyer or implementer — someone wiring Wiqly into their CRM, customising the embed, or building automation on top of the events Wiqly emits.
If you're a small-business owner who just wants to embed a widget, you don't need anything here — the Quick start and Embedding guides cover what you need.
In this section
- API endpoints — public endpoints the widget itself uses, and what you can call from your own code
- Webhook payloads — exact schema for
lead.capturedevents - Embed script options — script tag attributes, programmatic control
- Analytics events — every event type Wiqly emits and what triggers each
Stability
These APIs are stable but still evolving. We'll give breaking-change notice via email and via the changelog. Non-breaking additions happen without notice.
Authentication
The public widget endpoints are tied to a widget's embed_token and don't require auth — they're what the widget script fetches at runtime, so they have to be public. The token only grants access to read the widget's configuration and write events/leads to it. There's no PII exposed; tokens can't be used to access your account.
Internal-facing endpoints (anything under /api/internal/) require authentication and are documented for completeness but aren't intended for third-party use.