To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Funnel action that awards a fixed or dynamically calculated number of points to a profile or organisation in a named points bucket. Configured as JSON with type name "grantRewards" on a funnel automation. When the automation fires, this looks up the points bucket (reward) by name, resolves the recipient (the lead's own profile by default, or a profile or organisation resolved from the recipientExpression), calculates the number of points to award from a fixed amount or an MVEL/kcode expression, and records the award through RewardService, optionally tagged with a PointsTag.
Group: Journeys
Implements: FunnelAction, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| fields | List<Pair<ExtraField,Object>> | Describes the editable fields of this action and their current values, used to render the action's edit form in the funnel automation admin UI. |
| funnelActionTypeId | String | The type identifier for this action, used to match it to its registered GrantRewardsFunnelActionType and to tag its JSON representation. |
| numPoints | Double | Fixed number of points to award. Only used when numPointsMvel is not set; if neither is set no points are awarded. |
| numPointsMvel | String | MVEL or kcode expression that calculates the number of points to award dynamically, evaluated against the lead's profile and funnel context. Takes precedence over the fixed numPoints value when set. |
| pointsBucketName | String | Name of the points bucket (reward) that points are awarded into. Resolved via PointsManager when the action runs. |
| reason | String | Free text explanation for the award, recorded against the transaction and shown in the recipient's reward history. |
| recipientExpression | String | MVEL or kcode expression that resolves the recipient of the award to a profile or organisation. When blank, the lead's own profile is used as the recipient. |
| tagName | String | Name of the PointsTag the award should be tagged with, used to categorise the transaction in reward reporting. |
Methods
getFunnelActionTypeId()
Returns: String
The type identifier for this action, used to match it to its registered GrantRewardsFunnelActionType and to tag its JSON representation.
getFields()
Returns: List<Pair<ExtraField,Object>>
Describes the editable fields of this action and their current values, used to render the action's edit form in the funnel automation admin UI.
getPointsBucketName()
Returns: String
Name of the points bucket (reward) that points are awarded into. Resolved via PointsManager when the action runs.
getNumPoints()
Returns: Double
Fixed number of points to award. Only used when numPointsMvel is not set; if neither is set no points are awarded.
getNumPointsMvel()
Returns: String
MVEL or kcode expression that calculates the number of points to award dynamically, evaluated against the lead's profile and funnel context. Takes precedence over the fixed numPoints value when set.
getTagName()
Returns: String
Name of the PointsTag the award should be tagged with, used to categorise the transaction in reward reporting.
getReason()
Returns: String
Free text explanation for the award, recorded against the transaction and shown in the recipient's reward history.
getRecipientExpression()
Returns: String
MVEL or kcode expression that resolves the recipient of the award to a profile or organisation. When blank, the lead's own profile is used as the recipient.
© 2025 Kademi Ltd