Lead Settings
Configure how leads arrive: hosted web forms, an embeddable form, and a public API with keys.
Overview
Capture Forms: create a form, then share its hosted URL or paste the embed snippet on your website. Submissions create leads with the form’s default source, consent record and your assignment rules. Honeypot and rate limiting are always on.
API Keys: a key lets another system (your website backend, a Zapier-style tool, an ad platform) POST a lead to /api/v1/public/crm/leads/<workspace> with header X-API-Key. The key is shown once; revoke it any time. Add an Idempotency-Key header to avoid duplicates on retries.
Inbound channels (email-to-lead, WhatsApp, social lead ads) are configured under CRM → Marketing → Channels with the provider’s own credentials. Until a provider is connected there, those sources answer “not configured”.
When to use lead settings
- You want website enquiries to become leads automatically.
- An external tool must push leads in.
Step by step
Screenshot for this step has not been captured yet — run npm run docs:flow.
Permissions
These permission keys control access (granted to roles in Administration → Roles & Permissions):
- crm.lead.read
- crm.lead.create
Automation
- New leads are scored and assigned automatically.