Custom Event Schemas

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

Custom Event Schemas

In this section, you can build your customized Event schemas which can be used later to set Event-based Campaigns - 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


  3. Fill in Basic settings and Attributes (optional)

  4. Set status to Active


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

Last updated