Lead created

Triggered when a lead is created, on any route - a Socket form, the
public API, Zapier, or a practitioner adding one by hand.

The payload contains the full Lead resource including owner, client,
contact and stage.

A lead created from a proposal that is already won or lost fires only
this event; no lead_won or lead_lost follows, because the outcome
predates the lead.

Sent only for practices subscribed to the Leads add-on.

Payload

Webhook envelope for lead events. The payload field contains the full Lead
resource, exactly as GET /api/v1/leads/{lead} returns it.

Stage-change events (lead_stage_changed, lead_won, lead_lost) add
previousStage and newStage alongside the lead's own fields. Stage names
are renamable by the practice, so key on id or systemKey rather than
name.

A lead reaching Won or Lost sends lead_stage_changed and the dedicated
event, so a receiver watching general movement does not miss the close.

Lead events are only sent for practices subscribed to the Leads add-on.

string
enum
required

The lead event type that triggered the webhook

Allowed:
payload
object
required
string
required
length between 16 and 16

Random 16-character string for replay detection

date-time
required

UTC timestamp of when the webhook was created (ISO 8601)

Response
200

Webhook received successfully

LoadingLoading…