A trigger/action rule attached to a funnel, run whenever a matching event occurs on one of its leads. FunnelManager fires checkAndDo for every automation on a funnel when a FunnelEvent occurs; if the trigger matches, and any optional checkFunction confirms it, the activation is recorded and the configured action is executed.
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| action | FunnelAction | Action executed when this automation's trigger matches and any checkFunction confirms it. |
| checkFunction | String | Name of an optional JS function in the funnel's script engine, called with the triggering event and this automation once the trigger matches; the action only runs if it returns a truthy value. |
| id | String | Identifier for this automation, unique within its funnel. Used to record activations against a lead via JourneyAutomation and to look the automation up with Funnel.findAutomationById. |
| trigger | FunnelTrigger | Condition that must match a funnel event, and be enabled, for this automation's action to run. |
Methods
getAction()
Returns: FunnelAction
Action executed when this automation's trigger matches and any checkFunction confirms it.
getId()
Returns: String
Identifier for this automation, unique within its funnel. Used to record activations against a lead via JourneyAutomation and to look the automation up with Funnel.findAutomationById.
getTrigger()
Returns: FunnelTrigger
Condition that must match a funnel event, and be enabled, for this automation's action to run.
getCheckFunction()
Returns: String
Name of an optional JS function in the funnel's script engine, called with the triggering event and this automation once the trigger matches; the action only runs if it returns a truthy value.