A funnel event fired by a marketplace app's own custom code to signal that something app-specific happened to a lead. It carries an app-chosen event id and a map of arbitrary string parameters, and is matched by RepoAppEventGoal nodes whose configured node type equals the event id, letting an app extend the funnel engine with its own event types without the platform needing to know about them in advance.
Group: Journeys
Implements: CommonFunnelEvent
Properties
| Property | Returns | Description |
|---|---|---|
| emailAttachments | List<EmailAttachmentBean> | Email attachments carried by this event, built from an "attachments" parameter if the app supplied one as a list of maps with name, id and type entries. |
| eventId | String | App-chosen identifier for this event, used to match it against the node type configured on a RepoAppEventGoal. |
| leadProfile | Profile | Profile of the lead this event relates to, used to find any lead currently progressing through a funnel for it. |
| parameters | Map<String,String> | Arbitrary string parameters the app attached to this event when it was fired, made available to a matching RepoAppEventGoal's JS method. This map is unmodifiable. |
| relatedLead | Lead | Lead directly associated with this event. This event type has no lead reference of its own, so this always returns null - any matching lead is found via the lead profile instead. |
Methods
getEventId()
Returns: String
App-chosen identifier for this event, used to match it against the node type configured on a RepoAppEventGoal.
getLeadProfile()
Returns: Profile
Profile of the lead this event relates to, used to find any lead currently progressing through a funnel for it.
getParameters()
Returns: Map<String,String>
Arbitrary string parameters the app attached to this event when it was fired, made available to a matching RepoAppEventGoal's JS method. This map is unmodifiable.
getRelatedLead()
Returns: Lead
Lead directly associated with this event. This event type has no lead reference of its own, so this always returns null - any matching lead is found via the lead profile instead.
getEmailAttachments()
Returns: List<EmailAttachmentBean>
Email attachments carried by this event, built from an "attachments" parameter if the app supplied one as a list of maps with name, id and type entries.