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
  • Sending Custom Event
  • Custom Events Overview
  • Browsing through the Custom events
  • Custom Event Details

Was this helpful?

  1. Main Features

Custom Events

In this section, you will learn about adding and managing custom events in Open Loyalty.

Last updated 10 months ago

Was this helpful?

Sending Custom Event

The Custom Event is a specific event that can be sent only via API, but first, you need to create in which you can specify conditions. However, to send the custom Event via API, use request: '', and here you need to specify:

  • Type - in here we must pass 'event system identifier', from 'Custom event schemas',

  • Customer data - data that will connect the event to the Member,

  • Body - with your condition from the schema, where you need to put value for the Attribute system identifier that you previously described.

  • Event date - creation date of the Event,

After sending a valid request, you will get a '200 OK' response with a created custom event ID. Also, such an Event now should appear in the 'Custom Events' tab.


Custom Events Overview

After finding yourself on the 'Custom Events' table view, you will have all sent Events present here. You can browse through them, or customize the view e.g. by picking how many rows per page you would like to see.


Browsing through the Custom events

As mentioned above, you can see all Events present as a table, which can be browsed not only via scroll but also by using a search table or filters.

Table Search by name:

Once you start typing the name, the results will change automatically.

Available filters, which can be picked from the list or via the search field:

  • Email

  • Custom Event date

  • Custom Event name

  • Loyalty card number

  • Member ID

  • Phone number

  • Type

To use filters, click on the +ADD FILTER button and a popup screen will show up, then you can pick 'Property' > 'Condition' > 'Value' and after picking the needed data just click on the 'Add Filter' purple button.

Conditions:

  • equals - where the name needs to be exact as a typed value

  • contains - in this case, there must be a partial match to the value

After that only matching records will be present. Also, the graphic presented as the pie chart will show the percentage and number of filtered records. If you would like to dismiss the filter just click on the 'X' button.


Custom Event Details

To access the selected record's details, click on it or the overflow button and from the list, pick the "see details" option. In the Details view, you have data like Custom event date, Custom event name, and assign Member's data passed during creation before. To dismiss details, click on the '< 'button, on the top, next to the Event ID.

POST/api/{storeCode}/customEvent
Custom event schemas