For the complete documentation index, see llms.txt. This page is also available as Markdown.

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:

1

Open Custom Event Schemas

In the Members menu, select Custom Events. Then select Custom Event Schemas.

2

Start a new schema

Click Add Event Schema.

3

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.

4

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:

  • Booleantrue or false

  • Datetime — for example, 2024-03-08T02:02:08+01:00

  • Number or Text

5

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

1

Select the schema

Find the event schema in the list.

2

Open the editor

Open the context menu and select Edit.

3

Save your changes

Make the required updates, then click Save.

Last updated

Was this helpful?