To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
A funnel trigger that wraps another trigger and rate-limits how often it is allowed to activate for the same lead within a rolling window of days. Delegates matching to the wrapped trigger, but first checks how many times the owning automation has already fired for the lead within the configured number of days; if that count is at or above the configured allowed number, the trigger does not match regardless of what the wrapped trigger would decide.
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| allowedNum | Integer | How many times the wrapped trigger is allowed to activate for the same lead within the configured interval. Null is treated as one. |
| description | String | A human readable summary of this trigger's configuration, used in the funnel automation admin UI. |
| fields | List<Pair<ExtraField,Object>> | The editable configuration fields for this trigger, paired with their current values, used to render the trigger's edit form in the funnel automation admin UI. Includes the fields of the wrapped trigger, if one is set. |
| funnelTriggerTypeId | String | Identifier of the funnel trigger type that creates this trigger, used to look up the matching DateFilterFunnelTriggerType and to select this class during JSON deserialisation. |
| numIntervals | Integer | Length, in days, of the rolling window used to count prior activations of the owning automation for the same lead. |
| wrapped | FunnelTrigger | The trigger this rate limit wraps; matching is delegated to it once the rate limit check passes. |
Methods
getFunnelTriggerTypeId()
Returns: String
Identifier of the funnel trigger type that creates this trigger, used to look up the matching DateFilterFunnelTriggerType and to select this class during JSON deserialisation.
getFields()
Returns: List<Pair<ExtraField,Object>>
The editable configuration fields for this trigger, paired with their current values, used to render the trigger's edit form in the funnel automation admin UI. Includes the fields of the wrapped trigger, if one is set.
getDescription()
Returns: String
A human readable summary of this trigger's configuration, used in the funnel automation admin UI.
getNumIntervals()
Returns: Integer
Length, in days, of the rolling window used to count prior activations of the owning automation for the same lead.
getAllowedNum()
Returns: Integer
How many times the wrapped trigger is allowed to activate for the same lead within the configured interval. Null is treated as one.
getWrapped()
Returns: FunnelTrigger
The trigger this rate limit wraps; matching is delegated to it once the rate limit check passes.
© 2025 Kademi Ltd