Registers the "grantRewards" funnel action type, letting a funnel automation be configured to award points to a user. Supplies the id, display title and description shown when choosing an action in the funnel automation editor, and builds a GrantRewardsFunnelAction instance from the submitted form when a developer configures one.
Group: Journeys
Implements: FunnelActionType
Properties
| Property | Returns | Description |
|---|---|---|
| description | String | Short description of what this action does, shown alongside its title in the funnel automation editor. |
| id | String | The type identifier for this action type, used to register it and to match it to GrantRewardsFunnelAction instances. |
| title | String | Display 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 GrantRewardsFunnelAction 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 GrantRewardsFunnelAction from the submitted form fields (points bucket name, points amount or expression, reason, tag name and recipient expression).
| Parameter | Description |
|---|---|
form | the submitted form data for the action's configuration fields |