Lexidesk Developer Docs

<!-- Floating bubble: paste before </body> (copy the exact tag from your dashboard) -->
<script
  src="https://lexidesk.ai/load-widget.js"
  data-widget-url="https://lexidesk.ai/widget?agentJwt=YOUR_AGENT_JWT"
></script>

<!-- Hero (full-width inline) -->
<script
  src="https://lexidesk.ai/load-hero-inline-widget.js"
  data-agent-jwt="YOUR_AGENT_JWT"
  data-backend-url="https://api.lexidesk.ai"
></script>
<iframe
  id="lexidesk-hero-iframe"
  src="https://lexidesk.ai/inline-widget/hero-section?agentJwt=YOUR_AGENT_JWT"
  title="Lexidesk Hero Widget"
  allow="microphone; autoplay; clipboard-read; clipboard-write"
  style="width:100%;height:100vh;border:0;display:block;overflow:hidden;"
></iframe>

<!-- Block (inline chat box). The <script> is optional, but required for
     marketing attribution AND for multi-widget coordination on the same page. -->
<script src="https://lexidesk.ai/load-block-inline-widget.js"></script>
<iframe
  id="lexidesk-block-iframe"
  src="https://lexidesk.ai/inline-widget/block?agentJwt=YOUR_AGENT_JWT"
  title="Lexidesk Block Widget"
  allow="microphone; autoplay; clipboard-read; clipboard-write"
  style="width:100%;height:600px;border:0;display:block;overflow:hidden;"
></iframe>

window.dataLayer.push({
  event: 'lexidesk_user_message',
  widgetType: 'hero',            // 'bubble' | 'hero' | 'block' — which surface
  widgetInstanceId: '…uuid…',    // which specific widget instance fired it
});

// Every Lexidesk push onto window.dataLayer has this shape:
type LexideskDataLayerEvent = {
  event:
    | 'lexidesk_widget_loaded'
    | 'lexidesk_chat_opened'
    | 'lexidesk_chat_closed'
    | 'lexidesk_user_message'
    | 'lexidesk_bot_message'
    | 'lexidesk_onboarding_passed'
    | 'lexidesk_contacts_submitted';
  widgetType: 'bubble' | 'hero' | 'block' | null;  // which surface
  widgetInstanceId: string | null;                 // which specific widget instance
};

<script>
  window.dataLayer = window.dataLayer || [];
  var LEXIDESK_EVENTS = [
    'lexidesk_widget_loaded','lexidesk_chat_opened','lexidesk_chat_closed',
    'lexidesk_user_message','lexidesk_bot_message','lexidesk_onboarding_passed','lexidesk_contacts_submitted'
  ];
  var _push = window.dataLayer.push.bind(window.dataLayer);
  window.dataLayer.push = function (entry) {
    if (entry && LEXIDESK_EVENTS.indexOf(entry.event) !== -1 && typeof gtag === 'function') {
      gtag('event', entry.event, {
        widget_type: entry.widgetType,
        widget_instance_id: entry.widgetInstanceId,
      });
    }
    return _push(entry);
  };
</script>

<script>
  // Tag this visitor with your own analytics/session id (e.g. GA client_id)
  window.lexidesk.setParentPageBrowserSessionId('GA1.2.123456.789');

  // Attach an arbitrary JSON object of host context (replaces on each call;
  // capped at 8 KB / 50 top-level keys). Forwarded to your CRM/webhook integrations.
  window.lexidesk.setParentPageBrowserSessionPayload({
    gaClientId: 'GA1.2.123456.789',
    crmContactId: 'abc-123',
    landingCampaign: 'spring-pi',
  });
</script>

// Host-page API available on window once a Lexidesk loader is present.
interface Window {
  lexidesk: {
    fireEvent(
      name:
        | 'HIDE_LEXIDESK_WIDGET'
        | 'SHOW_LEXIDESK_WIDGET'
        | 'START_OR_CONTINUE_LEXIDESK_WIDGET_CONVERSATION',
    ): void;
    setParentPageBrowserSessionId(id: string): void;
    setParentPageBrowserSessionPayload(payload: Record<string, unknown>): void;
  };
}

{
  "conversationId": "00000000-0000-0000-0000-000000000001",
  "conversationSource": "WEB_TEXT",
  "conversationReason": "NEW_CLIENT_ENQUIRY",
  "conversationOutcome": "QUALIFIED",
  "caseSummary": "Caller is seeking representation for a divorce…",
  "caseData": {
    "case_name": "Smith divorce enquiry",
    "short_case_description": "Contested divorce with custody questions",
    "reason_for_priority": "Time-sensitive custody hearing",
    "lead_priority": 7,
    "language": "en",
    "county": null,
    "opposing_parties": null
  },
  "lawTypes": { "Family": ["Divorce", "Child custody"] },
  "clientType": "PERSONAL",
  "isQualifiedLead": true,
  "leadQualificationStatus": "YES",
  "isQualifiedLeadReason": "Has a clear matter and is in-jurisdiction",
  "isDuringWorkingHours": true,
  "isBillable": true,
  "referredBy": null,
  "client": {
    "name": "Jane Smith",
    "email": "jane@example.com",
    "phone": "+441234567890",
    "contactedWithPhoneNumber": "+441234567890",
    "askedToContactWithPhoneNumber": null,
    "createdAt": "2026-06-16T12:05:00.000Z"
  },
  "agent": {
    "name": "Intake Agent",
    "email": "intake@kinglaw.example",
    "firmName": "King Law Offices",
    "timezone": "Europe/London"
  },
  "appointment": { "isBooked": true, "startsAt": "2026-06-20T15:00:00.000Z" },
  "appointmentOffer": { "name": "Free consult", "reason": "Qualified lead", "proposedUrl": "https://…" },
  "transfer": { "destinationName": "Senior PI Partner", "destinationPhoneNumber": "+441234500000", "reason": "High-value matter" },
  "attribution": {
    "browserSessionAttributionId": "11111111-1111-4111-8111-111111111111",
    "persistentAttributionId": "22222222-2222-4222-8222-222222222222",
    "parentPageBrowserSessionId": "GA1.2.123456.789",
    "parentPageBrowserSessionPayload": { "crmContactId": "abc-123" },
    "utmSource": "google", "utmMedium": "cpc", "utmCampaign": "summer",
    "utmTerm": "lawyer", "utmContent": "hero",
    "referrer": "https://google.com/search",
    "firstLoadedAtUrl": "https://kinglaw.example/",
    "firstLoadedAtUrlQuery": "?utm_source=google",
    "firstLoadedAtUrlFragment": "#top",
    "firstLoadedAtUrlFull": "https://kinglaw.example/?utm_source=google#top",
    "firstUserMessageAtUrl": "https://kinglaw.example/family-law",
    "lastUserMessageAtUrl": "https://kinglaw.example/pricing",
    "firstMessageAfterLoadSeconds": 42.5,
    "firstMessageAfterWidgetOpenSeconds": 12,
    "locationCity": "Charlotte", "locationRegion": "North Carolina", "locationCountry": "United States",
    "navigationJourney": [
      { "url": "https://kinglaw.example/", "durationSeconds": 30,
        "events": [{ "type": "lexidesk_chat_opened", "atSeconds": 10 }] }
    ]
  },
  "durationSeconds": 180,
  "timestamp": "2026-06-16T12:31:00.000Z",
  "eventType": "new_lead"
}

// ── Lexidesk post-conversation webhook payload (JSON body of the POST) ──────────
// All dates are serialized as ISO 8601 strings.

type AfterCallIntegrationPayload = {
  conversationId: string;
  conversationSource?: ConversationSource;
  conversationReason?: ConversationReason;
  conversationOutcome?: ConversationOutcome;
  transfer?: ConversationTransfer;
  caseSummary?: string;
  audioRecordingUrl?: string;
  createdAt: string;                       // ISO datetime
  updatedAt: string;                       // ISO datetime
  caseData?: CaseData;
  lawTypes?: Record<string, string[]>;     // practice area -> matter subtypes
  clientType?: ClientType;
  isQualifiedLead?: boolean;               // YES/MAYBE => true, NO => false
  leadQualificationStatus?: LeadQualificationStatus;
  isQualifiedLeadReason?: string;
  isDuringWorkingHours?: boolean;
  isBillable?: boolean;
  referredBy?: string;
  attribution?: ConversationAttribution;   // omitted for phone-only conversations
  client: {
    name?: string;
    email?: string;
    phone?: string;
    contactedWithPhoneNumber?: string;
    askedToContactWithPhoneNumber?: string;
    createdAt?: string;                    // ISO datetime
  };
  agent: {
    name?: string;
    email?: string;
    firmName?: string;
    timezone?: string;
  };
  appointment: {
    isBooked: boolean;
    startsAt?: string;                     // ISO datetime, present when booked
  };
  appointmentOffer: {
    name?: string | null;
    reason?: string | null;
    proposedUrl?: string | null;
  };
  durationSeconds?: number;
  timestamp: string;                       // ISO datetime the webhook was sent
  eventType: string;                       // always "new_lead" today
};

enum ConversationSource { PHONE, WEB_CALL, WEB_TEXT, SMS, EMAIL, WHATSAPP, WEB }
enum ClientType { PERSONAL, BUSINESS }
enum LeadQualificationStatus { YES, NO, MAYBE }

enum ConversationReason {
  // Prospective / new clients
  PROSPECT_NEW_CASE_ENQUIRY, PROSPECT_CONSULTATION_OR_BOOKING, PROSPECT_FEES_OR_PRICING,
  PROSPECT_SERVICE_INFO_OR_ELIGIBILITY, PROSPECT_URGENT_NEW_MATTER, PROSPECT_INTAKE_FOLLOW_UP,
  PROSPECT_REFERRED,
  // Existing clients
  CLIENT_ASKING_CASE_UPDATE, CLIENT_PROVIDING_CASE_UPDATE, CLIENT_GENERAL_QUESTION,
  CLIENT_STRATEGY_DISCUSSION, CLIENT_URGENT_ACTIVE_CASE, CLIENT_BILLING_OR_PAYMENT,
  CLIENT_APPOINTMENT_OR_RESCHEDULE,
  // Third parties
  THIRD_PARTY_OPPOSING_COUNSEL, THIRD_PARTY_COURT_OR_AGENCY, THIRD_PARTY_INSURANCE_COMPANY,
  THIRD_PARTY_SALES_OR_VENDOR_OUTREACH,
  // Internal / administrative
  ADMIN_RECRUITING_OR_JOB, ADMIN_MEDIA_ENQUIRY, ADMIN_REGULATORY_BODY,
  // General
  GENERAL_WRONG_NUMBER, GENERAL_OTHER,
}

enum ConversationOutcome {
  ABANDONED, PARTIALLY_ABANDONED, APPOINTMENT_PROPOSAL_REJECTED, APPOINTMENT_PROPOSAL_ACCEPTED,
  APPOINTMENT_BOOKED, CALLBACK_REQUESTED, REFERRED_AWAY, LEAD_TURNED_DOWN, MESSAGE_TAKEN,
  ESCALATED_TO_HUMAN, RESOLVED, GENERAL_OTHER,
}

type ConversationTransfer = {
  destinationPhoneNumber?: string;
  destinationName?: string;
  reason?: string;
};

type CaseData = {
  case_name: string;
  short_case_description: string;
  reason_for_priority: string;
  lead_priority: number;
  language: string;          // 2-letter ISO code, e.g. "en"
  county: string | null;
  opposing_parties: string | null;
};

type NavigationJourneyEvent = { type: string; atSeconds: number };
type NavigationJourneyEntry = {
  url: string;
  durationSeconds: number;
  events: NavigationJourneyEvent[];
};

// Note: 'fingerprint' exists on the internal attribution type but is NOT sent in the webhook.
type ConversationAttribution = {
  browserSessionAttributionId?: string;          // per-visit id (sessionStorage)
  persistentAttributionId?: string;              // returning-visitor id (localStorage)
  parentPageBrowserSessionId?: string;           // your own id, if set
  parentPageBrowserSessionPayload?: Record<string, unknown>;  // your own JSON, if set
  utmSource?: string;
  utmMedium?: string;
  utmCampaign?: string;
  utmTerm?: string;
  utmContent?: string;
  referrer?: string;
  firstLoadedAtUrl?: string;
  firstLoadedAtUrlQuery?: string;
  firstLoadedAtUrlFragment?: string;
  firstLoadedAtUrlFull?: string;
  firstUserMessageAtUrl?: string;
  lastUserMessageAtUrl?: string;
  firstMessageAfterLoadSeconds?: number;
  firstMessageAfterWidgetOpenSeconds?: number;
  locationCity?: string;
  locationRegion?: string;
  locationCountry?: string;
  navigationJourney?: NavigationJourneyEntry[];
};

Lexidesk Conversation:
https://app.lexidesk.ai/dashboard/conversations/CONVERSATION_ID

Is a Qualified Lead: Yes
Qualification Rationale:
Has a clear matter and is in-jurisdiction

Priority: 7
Priority Rationale:
Time-sensitive custody hearing

Summary:
Caller is seeking representation for a divorce…

Attribution:
Location: Charlotte, North Carolina, United States
First page: https://kinglaw.example/
Referrer: https://google.com/search
Contacts submitted on: https://kinglaw.example/pricing
Time on site before first message: 42.5s