Form-submit action that enrols the current user into a marketing journey (funnel) when a form is submitted. Registered under the XML action alias "start-journey-action". On a form submission it looks up the configured funnel by name and creates a new lead for the current user, entering it at the configured entry point (or the funnel's default entry point if none is set); if the journey name is blank or the funnel cannot be found, no lead is created. This action never returns a view or a redirect, and requires write-content privilege on the asset.
Group: Content
Implements: AssetAction
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Short label for this action, always "Start journey". |
| entryPoint | String | The journey node id that a new lead is entered at, or blank to use the funnel's default entry point. |
| journeyName | String | Name of the funnel (journey) that a form submission creates a lead in. |
| requiredPriviledge | Priviledge | Privilege a caller needs to invoke this action: write access to the asset's content. |
Methods
getDescription()
Returns: String
Short label for this action, always "Start journey".
getRequiredPriviledge()
Returns: Priviledge
Privilege a caller needs to invoke this action: write access to the asset's content.
getJourneyName()
Returns: String
Name of the funnel (journey) that a form submission creates a lead in.
getEntryPoint()
Returns: String
The journey node id that a new lead is entered at, or blank to use the funnel's default entry point.