Wraps a SubscriptionEvent as a FunnelEvent so a group membership change (subscribed, accepted, rejected, pending, removed, lapsed, payment overdue or reactivated) can drive a marketing funnel. Created by FunnelManager when a SubscriptionEvent is raised for an organisation with an active funnels app, then passed to onFunnelEvent so funnel goals such as GroupGoal can match against it and advance a lead through the funnel.
Group: Journeys
Implements: FunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| action | String | The name of the subscription action this event represents, one of the SubscriptionEvent.SubscriptionAction constants such as ACCEPTED, REJECTED or PENDING. |
| groupName | String | The name of the group the membership belongs to, used by goals such as GroupGoal to match this event against a configured group. |
| leadProfile | Profile | The profile whose membership changed, taken from the underlying subscription event's source profile. |
| relatedLead | Lead | Not used by this event; a subscription event has no directly related lead. |
| subscriptionEvent | SubscriptionEvent | The underlying platform subscription event this funnel event wraps. |
| websiteName | String | The name of the website the membership change was made through. |
Methods
toProps()
Returns: Map<String,Serializable>
Builds the event properties map used by the funnels engine and exposed to JS, including the subscription action name and URN references to the website and group membership involved.
getLeadProfile()
Returns: Profile
The profile whose membership changed, taken from the underlying subscription event's source profile.
getSubscriptionEvent()
Returns: SubscriptionEvent
The underlying platform subscription event this funnel event wraps.
getAction()
Returns: String
The name of the subscription action this event represents, one of the SubscriptionEvent.SubscriptionAction constants such as ACCEPTED, REJECTED or PENDING.
getGroupName()
Returns: String
The name of the group the membership belongs to, used by goals such as GroupGoal to match this event against a configured group.
getWebsiteName()
Returns: String
The name of the website the membership change was made through.
getRelatedLead()
Returns: Lead
Not used by this event; a subscription event has no directly related lead.