To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Fired when a profile has passed authentication but before the login is finalised, giving listeners a chance to veto it. Raised by the security manager after credentials, account enablement and any second factor checks have already succeeded, but before the profile is handed back as logged in. A listener can call setCancelLogin(true) to stop the login going ahead, for example to enforce an additional business rule. As a CommonFunnelEvent it is also visible to the funnels app for tracking login activity.
Group: Journeys
Implements: CommonAppEvent, CommonFunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| cancelLogin | boolean | Whether a listener has cancelled this login. |
| leadProfile | Profile | The profile associated with this login. Implements the funnels app's CommonFunnelEvent contract so login activity can be linked to a lead's profile. |
| profile | Profile | The profile that has passed authentication and is attempting to log in. |
| relatedLead | Lead | Always null, since a login event is not associated with any lead. |
Methods
getProfile()
Returns: Profile
The profile that has passed authentication and is attempting to log in.
isCancelLogin()
Returns: boolean
Whether a listener has cancelled this login.
setCancelLogin(boolean cancelLogin)
Returns: void
Sets whether this login should be cancelled. A listener sets this to true to veto a login that has already passed credential checks, so the profile will not be considered logged in.
| Parameter | Description |
|---|---|
cancelLogin | true to cancel the login, false (the default) to let it proceed |
getLeadProfile()
Returns: Profile
The profile associated with this login. Implements the funnels app's CommonFunnelEvent contract so login activity can be linked to a lead's profile.
getRelatedLead()
Returns: Lead
Always null, since a login event is not associated with any lead.
© 2025 Kademi Ltd