Custom Event Schemas
In this section, you will learn how to manage the custom event schemas.
Custom Event Schemas
Custom event schemas define events for event-based campaigns. Each schema provides an event name and optional attributes for campaign conditions.
Add a custom event schema
Follow these steps to create an event schema:
Open Custom Event Schemas
In the Members menu, select Custom Events. Then select Custom Event Schemas.
Start a new schema
Click Add Event Schema.

Complete the basic settings
Enter an Event system identifier and an Event name.
Use the system identifier when sending the event. For example, for bike_ride, send "type": "bike_ride" in the request body.
The event name appears in the Event name list when creating an event-based campaign.
Add attributes, if needed
Attributes let you build campaign conditions and reward members. They are available in the campaign Conditions type list.
Select one of these attribute types:
Boolean —
trueorfalseDatetime — for example,
2024-03-08T02:02:08+01:00Number or Text

Activate and create the schema
Set the schema status to Active. Then click Add Event Schema.
Filter custom event schemas
Use Add Filter to narrow the schema list. You can filter by:
Active
Create date
Event name
Event system identifier

Choose a property, condition, and value. Then click Add filter. Only matching schemas appear.
Use the search field above the table to find a schema by name. Use the table control below the list to change rows per page.

Edit a custom event schema
Select the schema
Find the event schema in the list.
Open the editor
Open the context menu and select Edit.
Save your changes
Make the required updates, then click Save.

Last updated
Was this helpful?

