{{ $appName }} documentation
Everything you need to install, configure, and get your first lead converted. Budget 15 minutes for quick-start, 60 minutes to have the whole stack automated.
Quick start
After installation, sign in as the super admin, create a tenant workspace, and walk through the onboarding wizard. The Getting Started Checklist on the dashboard guides you through the six moves that turn an empty shell into a working lead engine.
php artisan db:seed --class=DemoSeeder on a fresh install — it creates a demo tenant, users, leads, pipelines, automations, and forms.First-tenant setup
A tenant is a workspace — think "one company using LeadHub." The super admin creates tenants, and each tenant has its own leads, pipelines, forms, and users. Visit /super-admin/tenants to create one.
- Fill in the workspace name, slug, owner email.
- Pick a plan (Trial is fine to start).
- Set seat limit (how many users this tenant can invite).
- Save — the owner receives a welcome email.
Inviting your team
As a tenant admin, visit Settings → Team Members and click Invite. Enter their email and pick a role:
| Role | Can do |
|---|---|
| Agent | Work assigned leads, log activities, send emails |
| Manager | Everything an agent does + team reports + reassign leads |
| Admin | Full workspace access: pipelines, automations, integrations, billing |
Lead sources
LeadHub ingests leads from 18 sources out of the box: Meta Lead Ads, Instagram, TikTok, LinkedIn, Google Ads, WhatsApp, Telegram, Viber, Twitter, Snapchat, Pinterest, YouTube, Microsoft Ads, Typeform, JotForm, Calendly, IMAP email, and your own web forms.
Visit Integrations → Lead Sources → Connect. Each source asks for different credentials — Meta wants OAuth, Typeform wants an API key, IMAP wants host/port/login. Once connected, new leads start flowing automatically.
Web forms
Build a form in Leads → Forms. Choose fields, styling, multi-step flow, reCAPTCHA protection, and the pipeline + stage to drop submissions into. Each form gets a public URL at /forms/{tenant}/{slug} and an embed snippet for your site.
Embed widget
Need a floating "Get a quote" button on your website? Visit Tools → Lead Capture Widgets, customize the colors and position, and paste the <script> tag on your site. Widgets capture leads without leaving the visitor's current page.
Visitor tracking
Create a tracker in Tools → Web Tracking, paste the snippet on your site, and LeadHub records every page view. When a visitor submits a form or you call LeadHubTracker.identify(email), their historical page views retroactively link to that lead — so you can see which pages they browsed before converting.
<script src="https://your-site.com/tracking/UUID/track.js" async></script>
<script>
// Call this after a user logs in or fills a form:
LeadHubTracker.identify('user@example.com');
</script>
Pipelines
A pipeline is your sales process: New → Contacted → Qualified → Proposal → Won / Lost. Create one in Leads → Pipelines, drag to reorder stages, set win_probability on each stage for weighted forecasts. The Kanban board visualizes leads moving across stages.
Lead scoring
Score leads automatically. In Settings → Lead Scoring Rules, add rules like "source equals Meta = +10 points" or "company_size greater than 50 = +20 points". Scores recalculate on every update.
Companies
B2B sales is account-based. LeadHub auto-creates a Company when a lead comes in with a corporate email — jane@acme.com creates an Acme Corp record. Visit Leads → Companies to see all contacts grouped by account, with rolled-up pipeline values.
Custom fields
Every business is different. Define your own fields in Settings → Custom Fields: text, number, date, dropdown, multi-select, checkbox. Choose whether they show in the lead form, the lead table, or the filters. Values store in the custom_fields JSON column.
Deal values & revenue
Add a deal_value and expected_close_date to any lead. The Kanban board shows pipeline value per stage, the dashboard shows weighted forecast + won this month, and the revenue report compares periods.
Email threads
Send an email from a lead's page and the reply lands back in the thread — not as a brand-new lead. LeadHub matches by In-Reply-To and References headers, falling back to the From: address. Every outbound email also includes an open-tracking pixel and click-tracking redirector.
Email sequences
Build multi-step drip campaigns in Leads → Email Sequences. Each step has a delay (days + hours), a subject, and a body. Enroll one lead or enroll 500 at once via bulk action. Sequences auto-unenroll when the lead replies or when the deal is marked won.
WhatsApp / SMS / Telegram
Two-way messaging. Connect your WhatsApp Business API, Twilio, or Telegram bot in integrations, then use the Conversations page to chat with leads directly. Inbound messages create/update leads; outbound go out via the connected provider.
Automations
Visit Leads → Automations → + New. Pick a trigger (lead created, stage changed, score threshold, no activity, tag added, form submitted, manual). Add steps: conditions, delays, or actions. Actions include send email, assign lead, add tag, move stage, notify users, send Slack message, send SMS, fire webhook, create task.
Automation templates
Not sure where to start? Click Browse Templates on the automations list and install one of 8 pre-built workflows: Welcome New Lead, Round-Robin Assignment, Hot Lead Alert, Follow-up Reminder, Stage-Change Notification, Re-engage Cold Leads, Auto-Tag VIPs, Slack Alert on New Lead. Installed as disabled — review the steps and toggle on.
Integrations
Push leads to 39 external tools: HubSpot, Salesforce, Pipedrive, Zoho, Mailchimp, ActiveCampaign, Klaviyo, Slack, Microsoft Teams, Google Sheets, Notion, Airtable, Zapier, Make, N8n, and more. Visit Settings → Integrations → + New, pick the type, fill credentials, and set field mapping.
REST API
Full REST API at /api/v1. Create an API key in Settings → API Keys with scoped permissions (read:leads, write:leads, read:pipelines, etc.). Pass as Authorization: Bearer <key>. Interactive docs at /api/docs.
curl -X POST https://your-app.com/api/v1/leads \
-H "Authorization: Bearer lh_live_..." \
-H "Content-Type: application/json" \
-d '{"first_name":"Jane","email":"jane@acme.com","source":"web_form"}'
Outbound webhooks
Fire a POST to your own URL when things happen. Events: lead.created, lead.updated, lead.stage_changed, form.submitted, automation.triggered. Filter by source, status, stage, tags. HMAC-SHA256 signature in X-LeadHub-Signature header.