Docs
This guide explains the production capabilities used during guided onboarding. Provider and enterprise integrations are enabled only after their readiness checks have passed.
1. Create your workspace
InsureOS is currently provisioned through guided access. Your first tenant administrator is created by InsureOS operations; they can then invite teammates from Settings → Users, subject to the workspace seat limit.
2. Connect your providers
Go to Settings → Comms providers and add an API key per channel:
- SMS — Twilio (account SID, auth token and approved sender number).
- WhatsApp — Twilio WhatsApp Business sender.
- Email — Resend (API key and verified sending address).
- Calendar — Google OAuth through Settings → My connections once the connection has been enabled for your workspace. Microsoft calendar is not part of the current launch configuration.
Integrated voice, LinkedIn and unlisted email or WhatsApp providers are not part of the launch product. Unavailable connectors are disabled in the application rather than simulated.
3. Ingest leads
Available and guided lead-ingestion options:
- Manual — Leads → New lead.
- CSV import — Leads → Import with column mapping and consent capture.
- Google Sheets — guided connection and on-demand tab import after access is approved for the workspace.
- CRM import — available only where a specific connector has been scoped and acceptance-tested for the brokerage.
- Public webhook — POST to
/api/public/website/<tenantId>from your marketing site (see below).
4. Public lead-capture API
This endpoint is for a trusted website backend, not direct browser JavaScript. Generate the one-time ingestion secret in Integrations → Website lead API, sign the exact raw JSON body, and preserve explicit channel consent.
POST https://insure-os.co.uk/api/public/website/<tenantId>
Content-Type: application/json
X-InsureOS-Timestamp: <unix-seconds>
X-InsureOS-Signature: sha256=<HMAC-SHA256(secret, timestamp + "." + raw-body)>
{
"full_name": "Example Lead",
"email": "<lead-email>",
"phone": "+447700900000",
"product_interest": "life",
"consent": { "email": true, "sms": false },
"source": "homepage-hero",
"utm": { "source": "google", "campaign": "brand" }
}Signatures expire after five minutes and are compared in constant time. Valid requests return 201; invalid signatures return 401. The endpoint is also rate-limited per tenant and source IP. Leads enter the new stage and eligible automations run on their authenticated schedule.
5. Sequences & automations
Build multi-channel sequences in Sequences (drip steps with delay) and event-driven flows in Automations (lead created, status changed, score crossed threshold). Each send is gated against your plan's channel pool and the lead's consent record.
6. Compliance
Every lead has a Right to be forgotten action under Compliance that redacts the row plus all attached interactions and emails. A daily cron sweeps lost leads past your retention_days setting (defaults to 730 days).
7. Webhooks & cron
External callers hit routes under /api/public/*. The platform exposes:
/api/public/webhooks/<provider>/<tenantId>— provider callbacks enabled for that workspace after provider-specific verification and acceptance testing./api/public/webhooks/stripe— billing events./api/public/cron/retention-sweep— daily retention scrub.
Need help?
Email hello@insure-os.co.uk or open an issue in the workspace's shared inbox.