To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Funnel action that debits a number of points from a profile's or organisation's balance in a named points bucket. Configured as JSON with type name "debitPoints" 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 recipientMvel expression), calculates the number of points to debit from a fixed amount or an MVEL/kcode expression, and records the debit through RewardService.
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 DebitPointsFunnelActionType and to tag its JSON representation. |
| numPoints | Double | Fixed number of points to debit. Only used when numPointsMvel is not set; if neither is set no points are debited. |
| numPointsMvel | String | MVEL or kcode expression that calculates the number of points to debit 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 debited from. Resolved via PointsManager when the action runs. |
| reason | String | Free text explanation for the debit, recorded against the transaction and shown in the recipient's reward history. |
| reasonCode | String | Short code identifying the reason for the debit, used to categorise the transaction in reward reporting. |
| recipientMvel | String | MVEL or kcode expression that resolves the recipient of the debit to a profile, organisation or user id. When blank, the lead's own profile is used as the recipient. |
Methods
getFunnelActionTypeId()
Returns: String
The type identifier for this action, used to match it to its registered DebitPointsFunnelActionType 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 debited from. Resolved via PointsManager when the action runs.
getNumPoints()
Returns: Double
Fixed number of points to debit. Only used when numPointsMvel is not set; if neither is set no points are debited.
getNumPointsMvel()
Returns: String
MVEL or kcode expression that calculates the number of points to debit dynamically, evaluated against the lead's profile and funnel context. Takes precedence over the fixed numPoints value when set.
getReasonCode()
Returns: String
Short code identifying the reason for the debit, used to categorise the transaction in reward reporting.
getReason()
Returns: String
Free text explanation for the debit, recorded against the transaction and shown in the recipient's reward history.
getRecipientMvel()
Returns: String
MVEL or kcode expression that resolves the recipient of the debit to a profile, organisation or user id. When blank, the lead's own profile is used as the recipient.
© 2025 Kademi Ltd