To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Journey goal that is achieved when a referral is sent. Matches a ReferralEvent whose action is REFERRAL_SENT_BY_SENDER, or REFERRAL_SENT_TO_RECIPIENT when onRecipient is set, and then advances the journey to the configured next node. When it matches the sender's event, it records the referral's id on the lead so a later ReferralSignupGoal on the same journey can confirm that a signup relates to this same referral.
Group: Journeys
Extends: Goal
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Fixed display label for this goal in the journey editor: always "Referral sent". |
| nextNodeId | String | Identifier of the journey node to enter once this goal is achieved (a referral has been sent). May be null if no next node has been configured. |
| onRecipient | Boolean | Whether this goal only matches on the recipient's sent event rather than the sender's. When false or not set, the goal matches the sender's REFERRAL_SENT_BY_SENDER event; when true, it matches the recipient's REFERRAL_SENT_TO_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 sent event rather than the sender's. When false or not set, the goal matches the sender's REFERRAL_SENT_BY_SENDER event; when true, it matches the recipient's REFERRAL_SENT_TO_RECIPIENT event instead.
getNextNodeId()
Returns: String
Identifier of the journey node to enter once this goal is achieved (a referral has been sent). May be null if no next node has been configured.
© 2025 Kademi Ltd