Raw Event Webhook Schema
Frontend Events
Reward Interaction
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
timestamp | string | UTC timestamp of the event. | Any String Value |
eventName | enum | Name of a particular event. | "reward_interaction" |
pageName | enum | (any string representing client web app screen name): values depend on client DEVs | "reward_intro" |
action | enum | What action is being done like a copy, share, etc | "PLAY" |
game_name | enum | Title of game. | "spinthewheel" |
state | enum | Define the state of reward. | "pristine" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
status | enum | Describes the state of the coupon | "redeemable-unseen" |
selected_slot_index | number | Reward slot index | Any Integer Value |
reward_name | string | Title of reward | Any String Value |
reward_type | string | Define the type of reward as user coupon code, discount, etc | Any String Value |
code | string | coupon code value | Any String Value |
reward_amount | number | Amount of reward that is won by the user | Any Integer Value |
details | string | Details around reward. | Any String Value |
campaignName | string | Tittle of the campaign. | Any String Value |
user_id | string | User Identification. | Any String Value |
CTA Interaction
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
timestamp | string | UTC timestamp of the event. | Any String Value |
eventName | enum | Name of a particular event. | "cta_interaction" |
pageName | enum | (any string representing client web app screen name): values depend on client DEVs | "game" |
action | enum | What action is being done like a copy, share, etc | "OPEN_DEEPLINK" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
component_name | string | Name of component that is in use. | Any String Value |
reward_user_id | string | This represents an instance of the reward. | Any String Value |
user_name | string | Name of the logged-in user | Any String Value |
time_left | string | How many seconds users to answer | Any String Value |
value | string | Text on CTA | Any String Value |
user_id | string | User Identification. | Any String Value |
Program Interaction
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
timestamp | string | UTC timestamp of the event. | Any String Value |
eventName | enum | Name of a particular event. | "program_interaction" |
pageName | enum | (any string representing client web app screen name): values depend on client DEVs | "game" |
action | enum | What action is being done like a copy, share, etc | "LOAD_SUCCESS" |
program_name | enum | Name of a particular program | "gamechallenge" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
component_name | string | Name of component that is in use. | Any String Value |
group_name | string | Activity group name. | Any String Value |
activity | string | Name of activity or task. | Any String Value |
user_id | string | User Identification. | Any String Value |
Wallet Interaction
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
timestamp | string | UTC timestamp of the event. | Any String Value |
eventName | enum | Name of a particular event. | "wallet_interaction" |
pageName | enum | (any string representing client web app screen name): values depend on client DEVs | "game" |
action | enum | What action is being done like a copy, share, etc | "LOAD_SUCCESS" |
user_id | string | User Identification. | Any String Value |
Quiz Interaction
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
timestamp | string | UTC timestamp of the event. | Any String Value |
eventName | enum | Name of a particular event. | "quiz_interaction" |
session_id | string | It would unique for every app launch. | Any String Value |
pageName | enum | (any string representing client web app screen name): values depend on client DEVs | "game" |
action | enum | What action is being done like a copy, share, etc | "OPEN_DEEPLINK" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
reward_user_id | number | This represents an instance of the reward. | Any N Value |
question_index | string | Denotes index number of questions in total questions. | Any String Value |
correct_answer | string | Value of correct answers. | Any String Value |
user_answer | string | The chosen by the user. | Any String Value |
is_correct | boolean | Tells chosen answer is true or false | Any String Value |
time | string | How many seconds users to answer | Any String Value |
user_id | string | User Identification. | Any String Value |
Coupon Code Interaction
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
timestamp | string | UTC timestamp of the event. | Any String Value |
eventName | enum | Name of a particular event. | "coupon_code_interaction" |
pageName | enum | (any string representing client web app screen name): values depend on client DEVs | "game" |
action | enum | What action is being done like a copy, share, etc | "OPEN_DEEPLINK" |
game_name | enum | Reward experience name. | "gamechallenge" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
reward_user_id | string | This represents an instance of the reward. | Any String Value |
user_id | string | User Identification. | Any String Value |
Backend Events
Activity Completed
Triggered when the user completes an activity.
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
event_id | UUID string | UUID for the event | UUID |
event_name | enum | Type of a particular event. | "step_completed" |
steps_completed | number | A number of the steps were completed. | Any integer value. |
status | enum | Describes the state of the action | "pristine", "clicked", "completed", "in-progress" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
user_id | string | User Identification. | Any String Value |
client | string | This represents an instance of the client | Any String Value |
experience | enum | Type of activity | "spinthewheel","slotmachine","scratchcard","direct","memorygame","quiz","referral","multistep","streak","activity-scratchcard","collectthestamps","gamechallenge","unity","tossthecoin","rollthedice","unitygame","giftbox" |
total_steps | number | Total number of steps are there in experience. | Any Integer Value |
event_properties.stepsCompleted | number | Number of steps completed | Any Integer Value |
event_properties.totalSteps | number | Total Number of steps in campaign | Any Integer Value |
activity | object | ||
---|---|---|---|
count | number | number of activities | Any Integer Value |
activities | array of objects | List of all activities in a campaign | |
---|---|---|---|
limits | number | a number of times the user can perform this activity. | Any Integer Value |
completedCount | number | Count of completed activities from the set limit | Any Integer Value |
campaign | number | Campaign level limit for activity | Any Integer Value |
daily | number | Daily limit for the activity | Any Integer Value |
status | string | status of activity | Any of the following |
activityId | string | uniqueID for activity | String ID Specified During campaign creation. |
eventName | string | Name of the event send to complete activity | Any String value |
completedOn.$date | string | Date of completion | Any Date value |
Campaign activated
Triggered when a user starts a multi-step campaign.
event_name | enum | Type of a particular event. | "object_created" |
---|---|---|---|
event_id | string | UUID for the event | UUID |
status | enum | Describes the state of the action | "pristine", "clicked", "completed", "in-progress" |
campaign_id | string | This represents an instance of the campaign. | Any String Value |
user_id | string | User Identification. | Any String Value |
client | string | This represents an instance of the client | Any String Value |
experience | enum | Type of activity | "spinthewheel","slotmachine","scratchcard","direct","memorygame","quiz","referral","multistep","streak","activity-scratchcard","collectthestamps","gamechallenge","unity","tossthecoin","rollthedice","unitygame","giftbox" |
expiry | enum | Type of campaign validity | "absolute", "relative", "never" |
timestamp | ISO timestamp | Timestamp of the event | Any Timestamp value |
status | string | status of campaign | "pristine", "clicked", "completed", "in-progress" |
event_properties.stepsCompleted | number | Number of steps completed | Any Number |
event_properties.totalSteps | number | Total number of steps in campaign | Any Number |
limits.campaign | number | Total limit for completing activity | Any Number |
limits.daily | number | Total Daily limit for completing activity | Any Number |
completedCount.campaign | number | Activity Completed per campaign | Any Number |
completedCount.daily | number | Activity Completed today | Any Number |
activities | array of objects | List of all activities in a campaign | |
---|---|---|---|
limits | number | a number of times the user can perform this activity. | Any Integer Value |
completedCount | number | Count of completed activities from the set limit | Any Integer Value |
campaign | number | Campaign level limit for the activity | Any Integer Value |
daily | number | The daily limit for the activity | Any Integer Value |
status | string | status of activity | Any of the following |
activityId | string | uniqueID for activity | String ID Specified During campaign creation. |
eventName | string | Name of the event send to complete activity | Any String value |
completedOn | string | Date of completion | Any Date value |
timeLimit | object | ||
---|---|---|---|
expiresOn.$date | ISO timestamp | time of expiration for campaign |
programExpiry | object | ||
---|---|---|---|
type | string | type of expiration mode | Any of the following 1. absolute 2. relative 3. never |
expiry | Unix timestamp | Unix timestamp for program expiry | Any Timestamp |
expired | bool | flag to specify if a program is expired | Any bool value |
Activity Step Completed
Triggered when a user completes a sub-step of an activity (also triggered for steps of streaks)
FIELD | TYPE | DESCRIPTION | VALUES |
---|---|---|---|
eventId | string | UUID of the event | |
event_name | enum | Type of a particular event. | “sub_step_completed” |
status | string | Describes the state of the action | Any String Value |
campaignId | string | This represents an instance of the campaign. | Any String Value |
user_id | string | User Identification. | Any String Value |
client | string | This represents an instance of the client | Any String Value |
experience | enum | Type of activity | "spinthewheel","slotmachine","scratchcard","direct","memorygame","quiz","referral","multistep","streak","activity-scratchcard","collectthestamps","gamechallenge","unity","tossthecoin","rollthedice","unitygame","giftbox" |
totalSteps | number | Count of all step there in streek. | Any Integer Value |
timestamp | Timestamp | Timestamp of the event | Timestamp |
event_properties.stepsCompleted | number | Count of completed steps in a streek. | Any Number |
event_properties.totalSteps | number | Count of all steps in a streek. | Any Number |
activity | object | ||
---|---|---|---|
count | number | Count of total activities | Any Integer Value |
activities | array of objects | List of all activities in a campaign | |
---|---|---|---|
limits | number | a number of times the user can perform this activity. | Any Integer Value |
completedCount | number | Count of completed activities from the set limit | Any Integer Value |
campaign | number | Campaign level limit for the activity | Any Integer Value |
daily | number | The daily limit for the activity | Any Integer Value |
status | string | status of activity | Any of the following |
activityId | string | uniqueID for activity | String ID Specified During campaign creation. |
eventName | string | Name of the event send to complete activity | Any String value |
completedOn | string | Date of completion | Any Date value |
Campaign Expired
Triggered when a multistep/game challenge campaign expires for a user.
Name | Type | Description | Values |
---|---|---|---|
event_name | string | Name of the event | "CAMPAIGN_EXPIRED" |
event_id | UUID | ID for event | UUID |
client | string | client ID | UUID |
user_id | string | user ID for the event | userID string |
analytics_version | string | version of the event | version string |
timestamp | timestamp | timestamp of the event | Any timestamp |
event_properties | object | addtional event properties | campaign_details object |
campaign_expiry | timestamp | timestamp of event expiry | Any timestamp |
campaign_id | string | campaign ID | Any string |
campaign_name | string | Name of the campaign | Any string |
campaign_expiration_type | enum | Type of expiration logic | "ABSOLUTE" "RELATIVE" |
campaign_expired | boolean | flag for campaign expiration object | boolean |
campaign_experience | enum | experience of the campaign | "MEMORYGAME" , "QUIZ" , "SPINTHEWHEEL" , "SCRATCHCARD" , "SLOTMACHINE" , "GIFTBOX" , "ROLLTHEDICE" , "SWIPEUI", "TOSSTHECOIN" |
campaign_state | enum | Global status of the campaign | "RUNNING" "STOPPED" |
Last updated