Journey goal that is achieved when a referral converts to a signup. Matches a ReferralEvent whose action is REFERRAL_SIGNUP_SENDER, or REFERRAL_SIGNUP_RECIPIENT when onRecipient is set, and whose referral matches the one recorded earlier on the same lead by a ReferralSentGoal (via the LEAD_ATT_REFERRAL_ID lead field), then advances the journey to the configured next node.

Group: Journeys

Extends: Goal


Properties

PropertyReturnsDescription
descriptionStringFixed display label for this goal in the journey editor: always "Referral sent".
nextNodeIdStringIdentifier of the journey node to enter once this goal is achieved (the referral has converted to a signup). May be null if no next node has been configured.
onRecipientBooleanWhether this goal only matches on the recipient's signup event rather than the sender's. When false or not set, the goal matches the sender's REFERRAL_SIGNUP_SENDER event; when true, it matches the recipient's REFERRAL_SIGNUP_RECIPIENT event instead.

Methods

getDescription()

Returns: String

Fixed display label for this goal in the journey editor: always "Referral sent".

getOnRecipient()

Returns: Boolean

Whether this goal only matches on the recipient's signup event rather than the sender's. When false or not set, the goal matches the sender's REFERRAL_SIGNUP_SENDER event; when true, it matches the recipient's REFERRAL_SIGNUP_RECIPIENT event instead.

getNextNodeId()

Returns: String

Identifier of the journey node to enter once this goal is achieved (the referral has converted to a signup). May be null if no next node has been configured.

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