Internal events
Internal events are automatically generated by the Loyalty Engine during its operations. These events cannot be triggered from external sources such as webhooks or API requests.
activity
This event is recorded in a customer's event history when the customer completes a challenge.
| Attribute | Description | Type |
|---|---|---|
| activity | The unique identifier of the challenge that the customer completed. | select |
booking
This event is recorded in a customer's event history when the customer makes a booking through Bookenda.
| Attribute | Description | Type |
|---|---|---|
| bookenda_id | The unique ID associated with the booking made by the customer. | string |
coupon_assign
This event is recorded in customers' event histories when a coupon is assigned to a customer through an Assign coupon workflow node.
| Attribute | Description | Type |
|---|---|---|
| coupon | The unique identifier of the coupon that is being assigned to the customer. | string |
| code | The coupon code assigned to the customer. | string |
coupon_change
This event is recorded in a customer's event history when a coupon assigned to the customer is modified through a Modify coupon workflow node.
| Attribute | Description | Type |
|---|---|---|
| code | The code of the modified coupon. | string |
| before | The attributes of the coupon before the modification. | object |
| after | The attributes of the coupon after the modification. | object |
coupon_receive
This event is recorded in customers' event histories when a customer receives a coupon through a coupon transfer.
| Attribute | Description | Type |
|---|---|---|
| code | The transferred coupon code. | string |
| original | The ID of the customer from whom the coupon was transferred. | string |
instagram_contest_enter
This event is recorded in customers' event histories when a customer enters an Instagram contest.
| Attribute | Description | Type |
|---|---|---|
| contest | The unique ID of the Instagram contest. | string |
| contest_type | The type or category of the Instagram contest (hashtag or comment) | select |
| entry | The ID of the customer's entry | string |
| media | The ID of the media object. | string |
| permalink | The URL of the entry on Instagram. | string |
| caption | The caption or description that goes along with the entry on Instagram. | string |
| media_url | The URL of the media content (e.g., photo or video) associated with the entry. | string |
| text | Additional text or message associated with the entry. | string |
instagram_contest_nonwinner
This event is recorded in customers' event histories for customers who entered an Instagram contest but did not win after the winner selection.
| Attribute | Description | Type |
|---|---|---|
| contest | The unique ID of the Instagram contest. | string |
| contest_type | The type or category of the Instagram contest (hashtag or comment) | select |
| entry | The ID of the customer's entry. | string |
| media | The ID of the media object | string |
| permalink | The URL of the entry on Instagram. | string |
| caption | The caption or description that goes along with the entry on Instagram. | string |
| media_url | The URL of the media content (e.g., photo or video) associated with the entry. | string |
| text | Additional text or message associated with the entry. | string |
instagram_contest_winner
This event is recorded in customers' event histories for customers who entered an Instagram contest and won after the winner selection.
| Attribute | Description | Type |
|---|---|---|
| contest | The unique ID of the Instagram contest. | string |
| contest_type | The type or category of the Instagram contest (hashtag or comment) | select |
| entry | The ID of the customer's entry | string |
| media | The ID of the media object. | string |
| permalink | The URL of the entry on Instagram. | string |
| caption | The caption or description that goes along with the entry on Instagram. | string |
| media_url | The URL of the media content (e.g., photo or video) associated with the entry. | string |
| text | Additional text or message associated with the entry. | string |
mapping
This event is recorded in customers' event histories when the Customer mapping module updates customer attributes based on predefined grouping sets.
| Attribute | Description | Type |
|---|---|---|
| rule | The ID of the mapping rule applied to update customer attributes. | string |
| before | The value of the customer attribute before the mapping update. | object |
| after | The value of the customer attribute after the mapping update. | object |
merge
This event is recorded in customers' event histories when a customer is merged into another customer. It is logged on the target customer's profile.
| Attribute | Description | Type |
|---|---|---|
| source | The customer ID of the source customer being merged. | string |
newsletter_open
This event is recorded in customers' event histories when a customer opens a newsletter that contains the tracking code.
| Attribute | Description | Type |
|---|---|---|
| campaign | The unique ID of the newsletter campaign that the customer opened. | string |
offer_redeem
This event is recorded in customers' event histories when an offer is redeemed by a customer.
It is automatically logged if the offers attribute of the checkout event points to any existing offer’s unique ID.
| Attribute | Description | Type |
|---|---|---|
| offer | The unique ID of the offer that the customer redeemed. | string |
pending_expired
This event is recorded in customers' event histories when any of the customer’s pending events expire.
| Attribute | Description | Type |
|---|---|---|
| points | The number of points associated with the expired pending event. | numeric |
point_unburn
This event is recorded in customers' event histories when points that were previously burned are restored as a result of a refund.
| Attribute | Description | Type |
|---|---|---|
| transaction_id | The unique identifier associated with the transaction where the points were initially deducted. | string |
profiling_answer
This event is recorded in customers' event histories when a customer responds to a profiling question, as logged through a request sent to the Display API Profiling POST endpoint.
Attribute | Description | Type |
|---|---|---|
question | The ID of the profiling question to which the customer responded. | string |
answer | The customer's response to the profiling question. The type of the value depends on the type of the question. | mixed |
tags | Any additional tags or categories associated with the question or response. | list |
profiling_flow
This event is recorded in customers' event histories when a customer completes all the questions within a profiling flow, captured through requests sent to the Profiling POST endpoint.
| Attribute | Description | Type |
|---|---|---|
| flow | The ID of the profiling question flow that the customer completed. | string |
| events | The IDs of the profiling_answer events that the customer completed the flow with. | list |
quiz
This event is recorded in customers' event histories when a customer completes a quiz.
| Attribute | Description | Type |
|---|---|---|
| quiz | The identifier or name of the quiz completed by the customer. | string |
| answer | The order number of selected answer(s) chosen by the customer. | numeric |
| answer_text | The text of the selected answer(s). | string |
| is_correct | Indicates whether the answer(s) provided are correct. | boolean |
| last_answer_time | Timestamp indicating the date and time of the customer's most recent answer in the quiz. | string |
| selection | A list of possible answers from which the customer is expected to choose the correct answer. | list |
share_intent_success
Triggered when a share intent submitted via the Social Share Campaigns API matches the criteria of a configured Social Share Campaign.
| Attribute | Description | Type |
|---|---|---|
| campaign_id | The unique identifier of the campaign in which the share intent was successfully validated. | string |
tier_change
This event is recorded in a customer's event history when the customer's tier changes due to tier expiration. This occurs when a customer's tier expires and is either renewed automatically or updated through workflow processes.
| Attribute | Description | Type |
|---|---|---|
| tier | The ID of the customer's new tier (new tier after the tier change). | string |
| structure | The ID of the tier structure where the tier is defined, | string |
| expdate | The expiration date of the new tier. | date |
tier_down
This event is recorded in customers' event histories when a customer has been demoted to a lower tier. Note that the demotion may not necessarily be by one tier.
| Attribute | Description | Type |
|---|---|---|
| tier | The ID of the customer's tier (new tier after the tier change). | string |
| structure | The ID of the tier structure where the tier is defined, | string |
| name | The name of the tier (new tier after the tier change). | string |
tier_remove
This event is automatically recorded in customers' event histories when a loyalty member is removed from an invitation-only tier structure through a Remove tier node of a workflow.
| Attribute | Description | Type |
|---|---|---|
| tier | The ID of the customer's tier. | string |
| structure | The ID of the tier structure where the tier is defined. | string |
tier_up
This event is recorded in a customer's event history when the customer is promoted to a higher tier.
| Attribute | Description | Type |
|---|---|---|
| tier | The ID of the customer's tier (new tier after the tier change). | string |
| structure | The ID of the tier structure where the tier is defined, | string |
| expdate | The expiration date of the new tier. | date |
| manual | Indicates if the tier-up is the result of a manual intervention. | boolean |
points_expired
This event is recorded in customers' event histories when a customer's points expire.
contest_entry_refund
This event is recorded in customers' event histories upon contest revoke if the Revoke from contest node of a workflow is configured to refund the points that were spent to enter the contest.
| Attribute | Description | Type |
|---|---|---|
| contest_id | The ID of the contest of the entry that was refunded. | string |
promotion_enter
This event is recorded in customers' event histories when a customer enters a contest. It can be triggered via the Display API or by the Workflows module Participate in contest node.
| Attribute | Description | Type |
|---|---|---|
| promotion | The ID of the contest. | string |
| count | The number of entries added. | numeric |
promotion_winner
This event is recorded in customers' event histories when a customer is selected as a contest winner.
| Attribute | Description | Type |
|---|---|---|
| promotion | The ID of the contest. | string |
| deleted | Indicates whether a new winner has been selected by conducting another draw. | boolean |
reward_bid
This event is recorded in customers' event histories when a customer places a bid on a reward item.
| Attribute | Description | Type |
|---|---|---|
| reward_id | The ID of the reward. | string |
| bid | The point value of the bid placed. | numeric |
reward_unbid
This event is recorded in customers' event histories when a customer's bid is refunded.
| Attribute | Description | Type |
|---|---|---|
| reward_id | The ID of the reward. | string |
| released | The number of points reserved when the bid was placed. | numeric |
reward_bidding_lost
This event is recorded in customers' event histories at the conclusion of a bidding process for customers who did not win the bid.
| Attribute | Description | Type |
|---|---|---|
| reward | The ID of the reward. | string |
reward
This event is recorded in customers' event histories when a customer claims a reward.
| Attribute | Description | Type |
|---|---|---|
| reward | The ID of the reward. | string |
| coupon | The coupon code assigned, if a coupon-type reward was claimed. | string |
| cost | The associated business cost of the reward. | numeric |
| club_id | A unique identifier of club (if any) associated with the reward claim event. | string |
| club_points | The number of points spent from the club balance (if any) for claiming the reward. | numeric |
reward_receive
This event is recorded in customers' event histories when a customer receives a reward from another customer via a reward transfer.
| Attribute | Description | Type |
|---|---|---|
| original | The ID of the customer from whom the reward was transferred. | string |
| reward | The ID of the reward. | string |
campaign_bonus
This event is recorded in customers' event histories when a Campaign bonus node of a workflow adds points to the customer's point balance.
| Attribute | Description | Type |
|---|---|---|
| points | The number of bonus points awarded by the workflow node. | numeric |
| description | The description added in the node settings. | string |
| capped | Indicates whether the customer reaches the limit of the number of bonus points to be earned within a campaign. | boolean |
pending_campaign_bonus
This event is registered in customers' event histories if the Checkout accept module is used and the Campaign bonus workflow node assigns points for a purchase. The bonus points remain pending until the purchase is accepted/rejected.
| Attribute | Description | Type |
|---|---|---|
| points | The number of bonus points to be awarded by the workflow node when the purchase is accepted. | numeric |
| description | The description added in the node settings. | string |
| capped | Indicates whether the customer reaches the limit of the number of bonus points to be earned within a campaign. | boolean |
campaign_bonus_revoke
This event is recorded in customers' event histories when points awarded by a Campaign bonus workflow node are revoked due to a refunded checkout.
| Attribute | Description | Type |
|---|---|---|
| points | The number of bonus points refunded. | numeric |
club_applicant_accept
This event is recorded in customers' and clubs' event histories when customers' club applications are accepted.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the customer who approved the application. | string |
| club_id | The ID of the club the applicant is joining. | string |
| previous_status | The status of the applicant before approval. | string |
| next_status | The new status of the applicant after approval. | string |
| reason | Reason provided for accepting the applicant (optional). | string |
club_applicant_refuse
This event is recorded in customers' and clubs' event histories when a customer’s club application is refused. The customer can apply to the club again in the future.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the customer who refused the application. | string |
| club_id | The ID of the club the applicant attempted to join. | string |
| previous_status | The status of the applicant before rejection. | string |
| next_status | The new status of the applicant after rejection. | string |
| reason | Reason provided for rejecting the applicant (optional). | string |
club_create
This event is recorded in customers' and clubs' event histories when a new club is created.
| Attribute | Description | Type |
|---|---|---|
| club_name | The name of the newly created club. | string |
| club_template_id | The ID of the club template used to create the club. | string |
| club_id | The ID of the newly created club (computed by the system). | string (computed) |
club_detail_change
This event is recorded in customers' and clubs' event histories when the name of a club is updated.
| Attribute | Description | Type |
|---|---|---|
| club_id | The ID of the club being updated. | string |
| club_name_new | The updated club name. | string |
| club_name_previous | The club name before the update. | string |
| reason | Reason provided for the change (optional). | string |
club_disband
This event is recorded in customers' and clubs' event histories when a club is disbanded.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the customer who disbanded the club. | string |
| club_id | The ID of the disbanded club. | string |
| reason | Reason provided for disbanding the club (optional). | string |
club_ownership_assign
This event is recorded in customers' and clubs' event histories when club ownership is assigned to a new owner.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the club with the new owner. | string |
| club_id | The ID of the customer assigning the ownership. | string |
| reason | Reason provided for reassigning the ownership (optional). | string |
club_member_ban
This event is recorded in customers' and clubs' event histories when a member is banned from the club. The customer cannot join the club again.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the customer who banned the member. | string |
| club_id | The ID of the club from which the member is banned. | string |
| previous_status | The member’s status before the ban. | string |
| next_status | The member’s status after the ban. | string |
| reason | Reason provided for banning the member (optional). | string |
club_member_join
This event is recorded in customers' and clubs' event histories when a customer joins a club.
| Attribute | Description | Type |
|---|---|---|
| club_id | The ID of the club the member has joined. | string |
| new_status | The status of the member after joining. | string |
| channel | Indicates how the member joined (optional). | string |
| invitation_id | The ID of the invitation used to join (private clubs only). | string |
club_member_remove
This event is recorded in customers' and clubs' event histories when a member is removed from a club. The customer can join the club again.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the customer removing the member. | string |
| club_id | The ID of the club from which the member is removed. | string |
| previous_status | The member’s status before removal. | string |
| new_status | The member’s status after removal. | string |
| reason | Reason provided for removing the member (optional). | string |
club_ownership_revoke
The event is recorded in customers' and clubs' event histories when ownership of a club is reassigned from the current owner.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the club with revoked ownership. | string |
| club_id | The ID of the customer initiating the reassignment of ownership. | string |
| reason | Reason for reassigning the ownership (optional). | string |
club_member_unban
This event is recorded when a previously banned member is unbanned.
| Attribute | Description | Type |
|---|---|---|
| actor | The ID of the customer unbanning the member. | string |
| club_id | The ID of the club. | string |
| previous_status | The member’s status before unbanning. | string |
| new_status | The member’s status after unbanning. | string |
| reason | Reason provided for unbanning (optional). | string |
club_point_contribution
This event is recorded in customers' and clubs' event histories when points are contributed to a club’s balance via member purchase.
| Attribute | Description | Type |
|---|---|---|
| club_id | The ID of the club receiving the contribution. | string |
| club_points | The number of points contributed to the club. | numeric |
| transaction_id | The ID of the transaction related to the contribution. | string |
| product_id | The ID of the product included in the transaction. | string (computed) |
| quantity | The quantity of the product purchased. | numeric (computed) |
| reason | Reason for the contribution (optional). | string |
| club_template_percentage | Percentage of the transaction points contributed to the club (defined by the club template). | string |
| conversion_rate | Club template conversion rate of the applied account group settings. | numeric |
club_point_remove
This event is recorded in customers' and clubs' event histories when points are deducted from the club’s balance through point adjustments.
| Attribute | Description | Type |
|---|---|---|
| club_id | The ID of the club losing the points. | string |
| club_points | The number of points deducted. | numeric |
| reason | Reason for removing the points (optional). | string |
club_point_donation
This event is recorded in customers' and clubs' event histories when points are donated to the club’s balance.
| Attribute | Description | Type |
|---|---|---|
| club_id | The ID of the club receiving the points. | string |
| donated_account_points | The number of account points the customer donated. | numeric |
| point_conversion_rate | The conversion rate of donated account points to club point. | numeric |
| donated_club_points | The number of points actually donated to the club, converted from donated account points. | numeric |
| reason | The reason for donation (optional). | string |
club_point_add
This event is recorded in customers' and clubs' event histories when points are added to the club’s balance through point adjustments.
| Attribute | Description | Type |
|---|---|---|
| club_id | ID of the club receiving the points. | string |
| club_points | The number of points added to the club’s balance. | numeric |
| reason | Reason for adding the points (optional). | string |
club_point_spent
This event is recorded in clubs' event histories when club points were spent to claim a reward.
| Attribute | Description | Type |
|---|---|---|
| customer_id | The ID of the customer who spent the points. | string |
| club_points | The number of points spent by the customer from the club’s balance. | numeric |
club_point_refund
This event is recorded in clubs' event histories when a transaction is refunded and points contributed to a club’s point balance is deducted.
| Attribute | Description | Type |
|---|---|---|
| customer_id | The ID of the customer whose transaction was refunded. | string |
| club_refunded_points | The number of points removed from the club’s balance due to the refund. | string |
| transaction_id | The ID of the refunded transaction. | string |
| product_id | The ID of the product included in the refunded transaction. | string (computed) |
| quantity | The number of items refunded in the transaction. | numeric (computed) |
club_reward_revoke
This event is recorded in clubs' event histories when a reward is revoked that has been claimed using club points.
| Attribute | Description | Type |
|---|---|---|
| customer_id | The ID of the customer whose reward was revoked. | string |
| club_points | The number of points retured to the club balance following the reward revocation. | numeric |
club_point_expiration
This event is recorded in clubs' event histories when club points expire.
| Attribute | Description | Type |
|---|---|---|
| club_id | The ID of the club where points have expired. | string |
| club_template_id | The ID of the club template to which the club belongs. | string |
| total_expired_points | The total number of club points that expired. | numeric |
Updated 4 days ago