lead.created - OmniAI Docs

{
  "event": "lead.created",
  "actor": {
    "type": "USER",
    "id": "8a1f6c2e-4b7d-4e2a-9c3f-1d5e6f7a8b9c",
    "name": "Jane Doe",
    "email": "jane@acme.com"
  },
  "data": {
    "leadId": "50713355-df73-4077-9d84-dcda6da5729c",
    "externalId": "ext-lead-001",
    "firstName": "John",
    "middleName": null,
    "lastName": "Doe",
    "phoneNumber": "+15551234567",
    "email": "john@example.com",
    "businessName": "Acme Inc",
    "website": "https://acme.com",
    "source": "inbound-email",
    "tags": ["VIP", "priority-1"]
  }
}

Triggered when a lead is created.

Event Type

lead.created

Description

This event is fired whenever a new lead is created in your workspace, whether via API, email, SMS, WhatsApp, or portal. Use this event to sync new leads to your CRM or trigger onboarding workflows.

Payload Structure

event

string

required

The event type: lead.created

data

object

required

The lead data

Show data

leadId

string

required

Unique identifier for the lead

externalId

string | null

External identifier for the lead (if set)

firstName

string | null

Lead’s first name

middleName

string | null

Lead’s middle name

lastName

string | null

Lead’s last name

phoneNumber

string | null

Lead’s phone number (E.164 format, e.g., +15551234567)

string | null

Lead’s email address

businessName

string | null

Lead’s business name

website

string | null

Lead’s website URL

source

string | null

How the lead was created: inbound-email, inbound-sms, inbound-whatsapp, admin-email, portal, api, http, salesforce

tags

string[]

Tags attached to the lead at creation, or an empty array when no tags were provided

actor

object | null

Workspace user who created this lead. Returns null for leads not created by a workspace user.

Show actor

type

enum

Type of actor

string

Unique identifier for the user

name

string | null

Name of the user

string

Email address of the user

{
  "event": "lead.created",
  "actor": {
    "type": "USER",
    "id": "8a1f6c2e-4b7d-4e2a-9c3f-1d5e6f7a8b9c",
    "name": "Jane Doe",
    "email": "jane@acme.com"
  },
  "data": {
    "leadId": "50713355-df73-4077-9d84-dcda6da5729c",
    "externalId": "ext-lead-001",
    "firstName": "John",
    "middleName": null,
    "lastName": "Doe",
    "phoneNumber": "+15551234567",
    "email": "john@example.com",
    "businessName": "Acme Inc",
    "website": "https://acme.com",
    "source": "inbound-email",
    "tags": ["VIP", "priority-1"]
  }
}

document.extracted lead.updated

​Event Type

​Description

​Payload Structure

Event Type

Description

Payload Structure