Custom Events

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

Sending Custom Event

The Custom Event is a specific event that can be sent only via API, but first, you need to create Custom event schemas in which you can specify conditions. However, to send the custom Event via API, use request: 'POST/api/{storeCode}/customEvent', 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.


  • 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.

Last updated