Custom event rule

Reward customer with defined amount of points for his action in external system. For example, share account with Facebook, add review for a product etc. If needed, you can also add repeatability limit to this rule type.

This Earning rule could be call only with API. Every run of API function will reward Customer with defined points.

To add new Custom event rule:

  1. Tap Earning rules on the Admin sidebar and choose Add earning rule. You can also add rule directly from All earning rules list by clicking Add earning rule at the top of the page
Add Rule Options Add Earning Rule Form
  1. In Basic information section, do the following:
  • Enter Name of the rule that will be displayed in views
  • Provide a brief Description of the rule that explains how to award points and information when the rule is active (thereby using to points calculation)
  • To activate the rule, in Active field select “Active” from the dropdown list
Custom event rule
  1. In Type details section set rule type as Custom event rule and complete details as follow:
  • in Custom event name enter name of the rule (to be used with calling API function)

  • provide number of Points that will be added after earning rule has been called

  • You can limit how many times customer could be rewarded for the same action with the specified period of time. Mark Usage limit active checkbox to limit repeatability. Leave it blank to reward customer for this rule without limits.

  • Period field is visible and required if Usage limit active is marked.

    It defines period of time within customer can be rewarded for this rule. Options include:
    • 1 day
    • 1 week
    • 1 month
    • 3 months
    • 6 months
    • 1 year
    • Forever
  • Limit field is visible and required if Usage limit active is marked.

    Provided number defines how many times customer could be rewarded for this rule in specified period of time.

    See Rule Types to learn more about Earning rules types


If customer used the limit then rule will not be shown on available rules list in Customer cockpit


once selected type can not be changed

  1. In Activity of rule section specify time boundaries when rule will be active
  • if you want the rule to be active all the time mark All time active checkbox
  • if you want the rule to be limited in time in Start at and End at fields specify dates between rule will be active
  1. In POS section, as an option you can assign an Earning rule to the existing POS. To do this, click POS field and choose store to which rule will be applied.

    When a transaction comes from a specific POS, only earning rules assigned to this POS will be used to calculate points.

Earning rule assignment to POS
  1. In Target section specify group of customers for which rule will be used. For example, Gold members will get 2 times more points than Bronze
  • In Target type choose from dropdown list Level or Segment to specify whether the rule will be active for customers assigned to particular level or segment.
  • Depending on the Target type field Segments to specify segments or Levels to specify levels appear. You can choose one or more levels/segments to used
Earning rule target option Earning rule target option
  1. If applicable, in Earning rule photo section upload image for Earning rule
Earning rule photo option
  1. When it is done, tap SAVE


Image size is limited to 2MB. Image dimensions could not be smaller than 600 x 600 px. Allowed file formats: png, gif, jpg.