Registers the "debitPoints" funnel action type, letting a funnel automation be configured to debit points from a user. Supplies the id, display title and description shown when choosing an action in the funnel automation editor, and builds a DebitPointsFunnelAction instance from the submitted form when a developer configures one.

Group: Journeys

Implements: FunnelActionType


Properties

PropertyReturnsDescription
descriptionStringShort description of what this action does, shown alongside its title in the funnel automation editor.
idStringThe type identifier for this action type, used to register it and to match it to DebitPointsFunnelAction instances.
titleStringDisplay title for this action type shown when a developer chooses an action in the funnel automation editor.

Methods

getId()

Returns: String

The type identifier for this action type, used to register it and to match it to DebitPointsFunnelAction instances.

getTitle()

Returns: String

Display title for this action type shown when a developer chooses an action in the funnel automation editor.

getDescription()

Returns: String

Short description of what this action does, shown alongside its title in the funnel automation editor.

create(FormContext form)

Returns: FunnelAction

Builds a new DebitPointsFunnelAction from the submitted form fields (points bucket name, points amount or expression, reason, reason code and recipient expression).

ParameterDescription
formthe submitted form data for the action's configuration fields
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.