Fired when a profile is created, updated or effectively removed from an organisation, so the search index and any listening funnel journeys can react. Raised by profile-management code across the platform - signup, group membership changes and profile edits - whenever a profile's data changes within an organisation. isDeleted is true when the profile no longer belongs to any group of the organisation and is not that organisation's home, in which case the search index entry should be dropped rather than updated. It is fired inside the caller's transaction and carries that transaction, so indexing is deferred until it completes, and getChangedProps records which fields changed. It is also a funnel event, triggering a ProfileUpdatedGoal so journeys waiting on a profile change can advance.

Group: Journeys

Implements: IndexedItemUpdatedEvent, FunnelEvent, CommonAppEvent


Properties

PropertyReturnsDescription
branchBranchAlways null - a profile change is not scoped to a website branch.
changedPropsSet<String>The names of the properties that changed on the profile, or null if the caller did not track which fields changed.
deletedbooleanWhether the profile should be removed from the search index rather than updated in it, as supplied to the constructor. True when the profile no longer belongs to any group of the organisation and is not that organisation's home.
leadProfileProfileThe profile this event is about, ie the person a funnel journey started from this event applies to.
profileProfileThe profile that changed, as supplied to the constructor. Never null.
relatedLeadLeadAlways null - a profile change is not raised against an existing funnel lead.
transactionTransactionThe transaction the profile was changed in. Re-indexing is deferred until this transaction completes.
triggeredGoalClass<? extends Goal>The goal type this event can satisfy, always ProfileUpdatedGoal, so journeys waiting on a profile change advance when it fires.
updatedObjectProfileThe profile that changed, and which should be re-indexed or removed from the index. Never null.
websiteWebsiteThe website the change was made through. Null if the change was not made through a website.

Methods

getChangedProps() · getBranch() · getUpdatedObject() · isDeleted() · getTransaction() · getLeadProfile() · getRelatedLead() · getWebsite() · getProfile() · getTriggeredGoal()

getChangedProps()

Returns: Set<String>

The names of the properties that changed on the profile, or null if the caller did not track which fields changed.

getBranch()

Returns: Branch

Always null - a profile change is not scoped to a website branch.

getUpdatedObject()

Returns: Profile

The profile that changed, and which should be re-indexed or removed from the index. Never null.

isDeleted()

Returns: boolean

Whether the profile should be removed from the search index rather than updated in it, as supplied to the constructor. True when the profile no longer belongs to any group of the organisation and is not that organisation's home.

getTransaction()

Returns: Transaction

The transaction the profile was changed in. Re-indexing is deferred until this transaction completes.

getLeadProfile()

Returns: Profile

The profile this event is about, ie the person a funnel journey started from this event applies to.

getRelatedLead()

Returns: Lead

Always null - a profile change is not raised against an existing funnel lead.

getWebsite()

Returns: Website

The website the change was made through. Null if the change was not made through a website.

getProfile()

Returns: Profile

The profile that changed, as supplied to the constructor. Never null.

getTriggeredGoal()

Returns: Class<? extends Goal>

The goal type this event can satisfy, always ProfileUpdatedGoal, so journeys waiting on a profile change advance when it fires.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.