Automation trigger that fires when points are granted into a specific points bucket, matched on a RewardGrantedEvent or RewardGrantedFunnelEvent. Can be further restricted to fire only when the resulting points balance falls within an optional minimum and maximum range. Registered as the "rewardGrantedTrigger" JSON subtype of FunnelTrigger.
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Human-readable summary of this trigger's configuration, naming the points bucket and any configured balance thresholds. |
| fields | List<Pair<ExtraField,Object>> | Configuration fields shown in the automation editor for this trigger: the points bucket and the optional minimum and maximum balance thresholds, paired with their currently configured values. |
| funnelTriggerTypeId | String | Identifier of the trigger type this trigger is an instance of, always "rewardGrantedTrigger". Used to look up the matching RewardGrantedFunnelTriggerType from the funnel manager's registry. |
| maxPointsBalance | Double | Optional upper bound on the resulting points balance. If set, the trigger only matches when the balance on the event is less than or equal to this value. |
| minPointsBalance | Double | Optional lower bound on the resulting points balance. If set, the trigger only matches when the balance on the event is greater than or equal to this value. |
| pointsBucket | String | Name of the points bucket (reward name) this trigger matches. Must be non-null for the trigger to ever match; an empty string matches a reward of any bucket. |
Methods
getFunnelTriggerTypeId()
Returns: String
Identifier of the trigger type this trigger is an instance of, always "rewardGrantedTrigger". Used to look up the matching RewardGrantedFunnelTriggerType from the funnel manager's registry.
getFields()
Returns: List<Pair<ExtraField,Object>>
Configuration fields shown in the automation editor for this trigger: the points bucket and the optional minimum and maximum balance thresholds, paired with their currently configured values.
getDescription()
Returns: String
Human-readable summary of this trigger's configuration, naming the points bucket and any configured balance thresholds.
getPointsBucket()
Returns: String
Name of the points bucket (reward name) this trigger matches. Must be non-null for the trigger to ever match; an empty string matches a reward of any bucket.
getMinPointsBalance()
Returns: Double
Optional lower bound on the resulting points balance. If set, the trigger only matches when the balance on the event is greater than or equal to this value.
getMaxPointsBalance()
Returns: Double
Optional upper bound on the resulting points balance. If set, the trigger only matches when the balance on the event is less than or equal to this value.