A funnel goal that is achieved when a lead's profile is updated while it belongs to a configured group. It matches profile-updated events, requiring the lead's profile to currently be a member of the named group, and optionally requiring an extra profile field to be blank, not blank, or equal to a specific value. It is used to branch a journey on changes to a member's own profile data.
Group: Journeys
Extends: Goal
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable summary of this goal for display in the funnel editor, naming the group it checks membership of. |
| fieldName | String | Name of the optional extra profile field this goal also checks. When set, the goal only matches if the field's value satisfies the configured field value rule (blank, not blank, or an exact match); when blank, the goal matches on group membership alone. |
| fieldValue | String | The rule applied to the extra field named by getFieldName, when configured: the special values "_blank" and "_notblank" require the field to be blank or not blank respectively, and any other value requires an exact match against the field's current value. |
| groupName | String | Name of the group the lead's profile must currently belong to for this goal to match. |
| nextNodeId | String | Id of the journey node to transition to once this goal matches. |
Methods
getDescription()
Returns: String
Human-readable summary of this goal for display in the funnel editor, naming the group it checks membership of.
getGroupName()
Returns: String
Name of the group the lead's profile must currently belong to for this goal to match.
getNextNodeId()
Returns: String
Id of the journey node to transition to once this goal matches.
getFieldName()
Returns: String
Name of the optional extra profile field this goal also checks. When set, the goal only matches if the field's value satisfies the configured field value rule (blank, not blank, or an exact match); when blank, the goal matches on group membership alone.
getFieldValue()
Returns: String
The rule applied to the extra field named by getFieldName, when configured: the special values "_blank" and "_notblank" require the field to be blank or not blank respectively, and any other value requires an exact match against the field's current value.