To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fired when a lead is ended, either because it completed or because it was cancelled. This event is raised in the context of the customer, ie the lead's own profile, and is intended to work with StartAndWaitFunnelGoal so that a separate journey started by that node can resume once the lead it is waiting on has ended.
Group: Journeys
Implements: FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| cancelled | boolean | Whether the lead was ended because it was cancelled, as opposed to being completed. |
| endedLead | Lead | The lead that ended. |
| leadFunnel | Funnel | The funnel that the ended lead belonged to. |
| leadProfile | Profile | The customer the ended lead was for, ie the ended lead's own profile. |
| relatedLead | Lead | The lead this event was raised for, ie the lead that ended. |
| triggeredGoal | Class<? extends Goal> | The goal type that this event can advance, ie StartAndWaitFunnelGoal. |
Methods
toProps()
Returns: Map<String,Serializable>
Builds the minimal event properties map for this event, adding isCancelled to the base properties from FunnelEvent.
isCancelled()
Returns: boolean
Whether the lead was ended because it was cancelled, as opposed to being completed.
getEndedLead()
Returns: Lead
The lead that ended.
getLeadFunnel()
Returns: Funnel
The funnel that the ended lead belonged to.
getLeadProfile()
Returns: Profile
The customer the ended lead was for, ie the ended lead's own profile.
getRelatedLead()
Returns: Lead
The lead this event was raised for, ie the lead that ended.
getTriggeredGoal()
Returns: Class<? extends Goal>
The goal type that this event can advance, ie StartAndWaitFunnelGoal.
© 2025 Kademi Ltd