LogoLogo
HomepageCase studiesBook a demo
User Guide
User Guide
  • Welcome to Open Loyalty!
  • What's New
    • 2024
    • 2023
    • 2022
  • What's Next
  • Technical Guide
  • Main Features
    • Global Management
      • Analytics
      • Settings
      • Config Duplication
      • Usage
    • Dashboard
      • General Overview
      • Units Wallet Overview
      • Additional Metrics
      • Members by Tiers
    • Members
      • Member List
        • Configuration
        • Creating Members
        • Managing Members
        • Removing Members
      • Segments
        • Creating Segments
        • Managing Segments
        • Segment Conditions
      • Referred Members
    • Campaigns
      • Creating Campaigns
        • Return Campaign
        • Referral Campaign
        • Time-Based Campaign
        • Redemption Code Campaign
        • Internal event - Achievement progressed
        • Percent value distribution
      • Managing Campaigns
      • Campaign Simulation
      • Follow-up Campaigns
    • Custom Events
      • Custom Event Schemas
    • Transactions
      • Adding Transactions
      • Managing Transactions
      • Channels
    • Tiers
      • Adding Tiers
      • Managing Tiers
      • Tiers Configuration
      • Tier Benefits
    • Wallets
      • Wallet Types and Configuration
      • Unit Transfers
        • Creating Unit Transfers
        • Importing Unit Transfers
        • Managing Unit Transfers
    • Achievements
      • Creating Achievement
      • Managing Achievements
      • Follow up Achievements
    • Rewards
      • Reward List
        • Rewards Configuration
        • Creating Reward
        • Reward Types
        • Units Conversion Coupon
        • Adding Coupons
        • Reward Flow
      • Reward Fulfillment
      • Reward Categories
    • Webhooks
      • How to Configure a Webhook
      • What Triggers a Webhook
      • Expiring Notifications
    • Collections
    • Imports / Exports
      • Imports
        • Sample Import Files
      • Exports
        • UI Data Exports
        • Configuration Exports
        • S3 Bucket Exports
    • Settings
      • Roles
      • Admins
        • System Logs
      • Tenants
      • Translations
    • Expressions
      • Attributes List
      • Operators
      • Custom Functions
      • Expression Examples
      • Sample Use Cases
        • Using Member Custom Attributes
        • Complex Effects (if, else)
        • Excluding Members
        • Elapsed Time Conditions
        • Using Additional Dates for Calculations
        • Register on Birthday
        • Transaction on Birthday
        • Tier Upgrade or Downgrade
  • Sample Setups
    • Good Practices
    • Pay with Points
    • Promo and Discounts in Cart
    • Sample Campaigns
      • #1 Earn 1 point for every $1 spent
      • #2 Earn 2x points when shopping on Monday morning
      • #3 Earn 1 stamp for every transaction
      • #4 Buy product ACME 123 and earn 100 points
      • #5 Refer a friend and get 100 points
      • #6 Refer 5 friends and get a $50 off coupon for the next purchase
      • #7 Register to the program and get 50 bonus points
      • #8 Get 30 bonus points for your first transaction in the loyalty program
      • #9 Cashback campaign
      • #10 Product meets selected criteria
    • Sample Achievements
      • #1 Celebrate summer - Buy 5 times between June and August
      • #2 Place 10 Orders above 50€ - Complete 10 transactions, for more than 50€ each
      • #3 Ambitious player - Log in to the game 3 times per week for 8 consecutive weeks
      • #4 SKU 'ABC' configuration - Spend total of 100$ on products with SKU 'ABC132' in September
      • #5 Workout track -Track a workout of at least 30 minutes for 5 days in a row
      • #6 4 referees made the transactions for 2 consecutive weeks
      • #7 2 referees made a transaction configuration
  • FAQ
    • Configuration Migration
    • Custom Attributes
    • Achievements
    • GDPR
    • Opt-Out
    • Referral Programs
    • Returns and Cancellations
Powered by GitBook
On this page
  • Custom Event Schemas
  • Adding custom event schema
  • Editing Custom Event Schema

Was this helpful?

  1. Main Features
  2. Custom Events

Custom Event Schemas

In this section, you will learn how to manage the custom event schemas.

Last updated 8 months ago

Was this helpful?

Custom Event Schemas

In this section, you can build your customized Event schemas which can be used later to set - the one which you will pick during creation, in the 'Event name' one of the created custom Event schema, and which are triggered by custom Events - based on custom Event schemas.

To access Custom Event schemas go to the Custom Events under the Members panel. Here you will see all the events presented in the table.


Adding custom event schema

To add Event Schema:

  1. Go to Members > Custom Events > CUSTOM EVENT SCHEMAS

  2. Click ADD EVENT SCHEMA

  3. Fill in Basic settings and Attributes (optional)

  4. Set status to Active

  5. Click ADD EVENT SCHEMA

Added custom Event schema will be present during creating Event based Campaign, on the 'Event name' list, also added attributes will be present on the 'Conditions type' list.

Fields available when creating Custom Event Schema:

  • Event system identifier - during creating the custom Event you will need to pass the Event system identifier: e.g. if you call your Event system identifier as "bike_ride" then in the request body you will pass: "type": "bike_ride"

  • Event name - during creating an Event-based Campaign in the 'Event name' dropdown list custom Event schemas names will be present.

  • Attribute (optional) - You can use attributes to create a Campaign with conditions based on those attributes and Reward Members.

The attribute can be used when creating an Event-Based campaign that determines the receipt of Units.

Available attribute types:

  • Boolean - true/false

  • Datetime - e.g. "2024-03-08T02:02:08+01:00"

  • Number

  • Text - 'string'

Filtering Custom event schemas

When there are a lot of records, you can change the number of rows displayed per page by clicking on the arrow icon below the table and picking a handy number from the list. You can also filter the results by clicking on the ADD FILTER button and picking a suitable option from the list:

  • Active

  • Create date

  • Event name

  • Event system identifier

the In Filter pop-up screen you will choose the Property mentioned above along with condition and value, after filling it up click on the 'Add filter', and only records fulfilling such criteria will be displayed.

Besides searching via filters you can use a Search Table available in the upper right corner under the 'Add Event Schema' button. The search field allows you to find the event schema via the name:


Editing Custom Event Schema

To edit Custom Event Schema:

  1. Select Event Schema from the list

  2. Click the context menu

  3. Click Edit

  4. Make changes

  5. Click SAVE

Event-based Campaigns