Get started with Events

Learn how to define, create, and report events in the Loyalty Engine to track user behaviour and trigger loyalty logic like points, rewards, and badges.

Events track user actions and business activity in the Loyalty Engine. Each event represents a moment in time and can trigger reactors that award points, issue rewards, grant badges, or call webhooks.

It’s up to you to decide which actions to capture, gather the data, and send those events from the business systems in which they originate to the Loyalty Engine via the API.

Every event contains three core elements:

Event type

The category or nature of the event, such as an account registration, reward purchase, transaction, survey completion, or new subscription.

Event subject

The user or entity associated with the event.

Event payload

The specific data related to the event, such as transaction amounts, survey answers, or subscription details.

Events are the data that fuel your loyalty program—but they don’t define the logic.

Events record what users do (e.g., make a purchase), while reactors respond to those events to trigger outcomes like awarding points, issuing rewards, or calling a webhook.

---

Setup your event-based loyalty program

1

Determine the behaviours you want to reward

Start by identifying the user behaviors you want to incentivize, and define what data you’ll need to capture for each one.

Here are a few simplified examples of common behaviours, along with the data you might include with each behaviour.

POS Transaction

• Transaction ID

• Total Spend

• Items Purchased

• Purchase Channel

Survey Completion

• Survey ID

• No. of Questions Answered

• Completion Score: 80%

New Subscription

• Subscription Plan

• Subscription Start Date

• Auto-renew

Opened App

• Device type

• App version

• Location

Product Review

• Rating

• Review content

Submitted Promo Code

• Code submitted

2

Create custom event types for each rewarded behavior

Use the Loyalty Console to create a custom event type for each user behavior you want to track and reward.

When setting up each event type, consider what data needs to be included in the event payload. This is defined by the event type’s schema and determines which conditions you’ll be able to use when configuring reactors.

For example, if you’re sending events to represent in-store transactions and want to award points when specific SKUs are purchased, make sure the event includes basket data in the payload.

3

Report events into the Loyalty Engine

Once your custom event types are defined, your systems must report events to the Loyalty Engine in real time via the API.

For example, when a customer completes a purchase, your e-commerce system should report an event using the event type you’ve created for transactions. The event payload should include relevant data—such as total spend, purchased products, or payment method—so that reactors can use this information to award points, issue rewards, or trigger other actions.