Funnel trigger that wraps another trigger and restricts it to firing at most once per lead, or optionally once per item for that lead. Configured as JSON with type name "oneShotTrigger" on a funnel automation, wrapping another configured trigger. Before delegating to the wrapped trigger, this checks JourneyAutomation records for the current automation, lead and (when applyPerItem is set) item id, and refuses to match again once a matching JourneyAutomation already exists.

Group: Journeys

Implements: FunnelTrigger, Serializable


Properties

PropertyReturnsDescription
applyPerItemBooleanWhether the one-shot restriction applies separately to each item the wrapped trigger identifies, rather than once for the lead overall.
descriptionStringHuman readable summary of this trigger's configuration, describing the wrapped trigger and whether the one-shot restriction applies once per item.
fieldsList<Pair<ExtraField,Object>>Describes the editable fields of this trigger and their current values, used to render the trigger's edit form in the funnel automation admin UI. Includes the applyPerItem field plus the wrapped trigger's own fields, if a trigger is wrapped.
funnelTriggerTypeIdStringThe type identifier for this trigger, used to match it to its registered OneShotFunnelTriggerType and to tag its JSON representation.
wrappedFunnelTriggerThe trigger this one-shot restriction wraps and delegates matching to.

Methods

getFunnelTriggerTypeId()

Returns: String

The type identifier for this trigger, used to match it to its registered OneShotFunnelTriggerType and to tag its JSON representation.

getFields()

Returns: List<Pair<ExtraField,Object>>

Describes the editable fields of this trigger and their current values, used to render the trigger's edit form in the funnel automation admin UI. Includes the applyPerItem field plus the wrapped trigger's own fields, if a trigger is wrapped.

getDescription()

Returns: String

Human readable summary of this trigger's configuration, describing the wrapped trigger and whether the one-shot restriction applies once per item.

getWrapped()

Returns: FunnelTrigger

The trigger this one-shot restriction wraps and delegates matching to.

getApplyPerItem()

Returns: Boolean

Whether the one-shot restriction applies separately to each item the wrapped trigger identifies, rather than once for the lead overall.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.