Available effects
Define effects in the Rule Builder.
This page lists the available effects.
In promotion rules, effects are triggered when all (or at least one) of the conditions of the rule are valid, following the logic
WHEN this happens THEN do that.You can trigger effects to send a notification, apply a discount to your customer's session or create a referral code.
In strikethrough rules, effects are triggered when changes occur in the campaign or in the cart item catalog connected to the corresponding Application. Strikethrough rules only trigger per-item effects.
Effects triggered by strikethrough rules add loyalty points, display a notification or apply a discount on specific items.
Once you have added effects to your rules via the Campaign Manager, the rest of the workflow happens via the Integration API.
The effects triggered by Talon.One are returned to your website/integration layer and it is up to you and your development team to decide how to apply them.
Learn how to process effects in the Developer Docs and see the JSON structure of each of them on thea API effects page.
The available effects appear sorted by these categories:
Most of the effects are always available, but some are only available when you enable specific features in your campaign.
Discount effects
| Effect name | Description | API effect |
|---|---|---|
| Discount session total | Applies a discount to the total value of a customer session. | setDiscount |
| Discount individual items | Applies a discount to certain items or their additional cost in the cart. Eligible items are discounted one by one. | setDiscountPerItem |
| Discount individual items pro rata | Applies a pro rata discount to certain items in the cart. | setDiscountPerItem |
| Discount bundles pro rata | Applies a pro rata discount to the items in one or more bundles. | setDiscountPerItem |
| Discount additional cost | Applies a discount to an additional cost, such as shipping costs or transaction fees. | setDiscountPerAdditionalCost |
| Discount additional cost per item | Applies a discount to an additional cost, such as a shipping cost, applied to an individual cart item. | setDiscountPerAdditionalCost |
Reward effects
| Effect name | Description | API effect |
|---|---|---|
| Add free item | Adds one or more free items to a customer's session. | addFreeItem |
| Add loyalty points | Adds loyalty points per session total to a customer's wallet or to a loyalty card. The loyalty feature must be enabled in the campaign. | addLoyaltyPoints |
| Add loyalty points per item | Adds loyalty points per cart item to a customer's wallet or to a loyalty card. The loyalty feature must be enabled in the campaign. | addLoyaltyPoints |
| Redeem loyalty points | Allows a customer to use their loyalty points. The loyalty feature must be enabled in the campaign. | deductLoyaltyPoints |
| Award giveaway | Grants a giveaway code to the customer. The giveaways feature must be enabled in the campaign. | awardGiveaway |
Create effects
| Effect name | Description | API effect |
|---|---|---|
| Create notification | Displays a notification to the customer. | showNotification |
| Create referral code | Generates a referral code for your customer. The referrals feature must be enabled in the campaign. | referralCreated |
| Create coupon code | Generates a coupon code of a gift card for your customer. The coupons feature must be enabled in the campaign. | couponCreated |
| Create coupon code reservation | Reserves a coupon code so it can only be redeemed by the current customer profile. The coupons feature must be enabled in the campaign. | reserveCoupon |
Update effects
| Effect name | Description | API effect |
|---|---|---|
| Update attribute value | Updates the value of a custom attribute. | updateAttribute |
| Update cart item attribute value | Updates the value of a custom attribute for the items in the customer's cart. | updateAttribute |
Webhooks
| Effect name | Description | API effect |
|---|---|---|
| Any custom webhooks you created. | To learn how to create webhooks, see the Developer docs. | triggerWebhook |
Custom effects
| Effect name | Description | API effect |
|---|---|---|
| Any custom effect you created. | To learn how to create custom effects, see Managing custom effects. | What you define as API name and payload. |