Funnel trigger fired when a shopping cart event occurs on a website, matched against one of three configured actions: item added to cart, payment pending, or checkout complete. Optionally scoped to a specific website by name; when no website is configured the trigger matches the configured action on any website.
Group: Journeys
Implements: FunnelTrigger, Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| action | String | The shopping cart action this trigger matches: one of Added to cart, Payment pending, or Checkout complete. |
| 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. |
| funnelTriggerTypeId | String | Identifier of the funnel trigger type that creates this trigger, used to look up the matching ShoppingCartFunnelTriggerType and to select this class during JSON deserialisation. |
| websiteName | String | Name of the website this trigger is scoped to. Null or blank means the trigger matches the configured shopping cart action on any website. |
Methods
getFunnelTriggerTypeId()
Returns: String
Identifier of the funnel trigger type that creates this trigger, used to look up the matching ShoppingCartFunnelTriggerType 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.
getDescription()
Returns: String
A human readable summary of this trigger's configuration, used in the funnel automation admin UI.
getAction()
Returns: String
The shopping cart action this trigger matches: one of Added to cart, Payment pending, or Checkout complete.
getWebsiteName()
Returns: String
Name of the website this trigger is scoped to. Null or blank means the trigger matches the configured shopping cart action on any website.