A funnel goal that is achieved when a lead is granted a promotion/reward entry matching a configured name and status. It matches reward-granted events, optionally requiring the reward name to equal a specific promotion (or matching any promotion) and the entry's status to equal a configured value. On entry it stashes the matched event's reward name on the lead so it can be referenced later in the journey.

Group: Journeys

Extends: Goal

Implements: Serializable


Properties

PropertyReturnsDescription
descriptionStringHuman-readable summary of this goal for display in the funnel editor, naming the promotion it watches for.
matchAllbooleanWhether this goal matches a reward-granted event for any promotion, ignoring the configured promotion name.
nextNodeIdStringId of the journey node to transition to once this goal matches.
promoNameStringName of the promotion/reward this goal watches for entries into, unless the match-all option is set.
promoStatusStringRequired reward entry status for this goal to match, as the name of a RewardEntry status value. When blank or not a recognised status, the entry's status is not checked.

Methods

getDescription()

Returns: String

Human-readable summary of this goal for display in the funnel editor, naming the promotion it watches for.

getPromoName()

Returns: String

Name of the promotion/reward this goal watches for entries into, unless the match-all option is set.

getPromoStatus()

Returns: String

Required reward entry status for this goal to match, as the name of a RewardEntry status value. When blank or not a recognised status, the entry's status is not checked.

getMatchAll()

Returns: boolean

Whether this goal matches a reward-granted event for any promotion, ignoring the configured promotion name.

getNextNodeId()

Returns: String

Id of the journey node to transition to once this goal matches.

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