Lead stage changed

webhook

leadStageChanged

Triggered whenever a lead moves between pipeline stages, custom stages
included.

Alongside the lead's own fields the payload carries previousStage and
newStage. Stage names are renamable by the practice, so key on id or
systemKey rather than name. Both stages are always present - every
lead sits in a stage, so every move has a real origin.

A lead reaching Won or Lost fires this event and lead_won /
lead_lost. Deleting a stage moves its leads to another column without
firing this event - that is an admin restructure, not pipeline
movement.

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.

event

string

enum

required

The lead event type that triggered the webhook

Allowed:

payload

object

required

entropy

string

required

length between 16 and 16

Random 16-character string for replay detection

timestamp

date-time

required

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

Response

200

Webhook received successfully