# Raw Event Webhook Schema ## Frontend Events ### Reward Interaction ```json { "timestamp": "2022-05-27T04:46:51.878Z", "event_name": "reward_interaction", "event_properties": { "page_name": "reward", "action": "PLAYED", "game_name": "spinthewheel", "state": "pristine", "campaign_id": "a1850915-ad4c-4b11-a093-e13d64362778", "reward_user_id": "4d36e9a7-913a-4fa6-9f31-0c96227bd77b", "user_id": "ba69a092-9d0f-4f14-99bc-393ddf1dbb66", "status": "redeemable-seen", "selected_slot_index": 2, "reward_name": "100 DotCoins", "reward_type": "points", "code": "XBDSA65", "reward_amount": 100, "details": { "campaignName": "Daily Reward" } }, "user_id": "test_user123" } ``` | 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 ```jsx { "timestamp": "2022-07-11T06:05:45.043Z", "event_name": "cta_interaction", "event_properties": { "page_name": "reward_intro", "action": "PLAY", "campaign_id": "ba0ca2f3-4651-48ae-9f00-9f7229b45cd5", "component_name": "button", "reward_user_id": "2b2eb949-a521-4dbb-8c3a-f159f62928bc", "user_name": "not_available", "time_left": "not_available", "value": "Play Quiz" }, "user_id": string; } ``` | 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 ```jsx { "timestamp": "2022-07-11T09:00:47.086Z", "event_name": "program_interaction", "event_properties": { "page_name": "program", "action": "load_success", "program_name": "gamechallenge", "campaign_id": "11c941dc-8bdb-4acd-964d-8f67012b64d2", "component_name": "not_available", "group_name": "not_available", "activity": "not_available" }, "user_id": string; } ``` | 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 ```jsx { "timestamp": "2022-07-11T09:16:48.917Z", "event_name": "wallet_interaction", "event_properties": { "pageName": "wallet", "action": "load_success" }, "user_id": string; } ``` | 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 ```jsx { "timestamp": "2022-07-11T13:49:19.136Z", "event_name": "quiz_interaction", "event_properties": { "session_id": "0.6494546164134896", "page_name": "game", "action": "answer_question", "campaign_id": "ba0ca2f3-4651-48ae-9f00-9f7229b45cd5", "reward_user_id": "560cad42-d325-465a-8467-1fa0d4060572", "question_index": 1, "correct_answer": "All of the above", "user_answer": "All of the above", "is_correct": true, "time": "not_available" }, "user_id": string; "4755018" } ``` | 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 ```jsx { "timestamp": "2022-07-11T13:12:37.729Z", "event_name": "coupon_code_interaction", "event_properties": { "page_name": "not_available", "action": "not_available", "game_name": "not_available", "value": "MW10KGDRV0", "campaign_id": "not_available", "reward_user_id": "not_available" }, "user_id": string; } ``` | 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. 
{
    "event_id": "3cf62184-09aa-4b71-be0e-7fa3310be7c3",
    "event_name":"step_completed",
    "steps_completed":1,
    "status":"in-progress",
    "campaign_id":"ewcw8ee0-474a-bxxqwqw-06f0b6c44a5",
    "user_id":"xyz",
    "client":"1qwxqwxwq-xqxqw-xqqx-7e28931",
    "activity":{
       "count":2,
       "activities":[
          {
             "limits":{
                "campaign":1,
                "daily":1
             },
             "completedCount":{
                "campaign":1,
                "daily":1
             },
             "status":"completed",
             "activityId":"completeProfile",
             "eventName":"WE_HOME_SCREEN_OPEN",
             "completedOn":{
                "$date":"2021-05-26T11:59:58.514Z"
             }
          },
          {
             "limits":{
                "campaign":1,
                "daily":1
             },
             "completedCount":{
                "campaign":0,
                "daily":0
             },
             "status":"pending",
             "activityId":"addTest",
             "eventName":"BACK_PROD_ADD_CLINICAL_TEST",
          }
       ],
    },
    "experience":"multistep",
    "total_steps":2,
    "timestamp": "2022-11-04T06:30:59Z",
    "event_properties": {
	"campaign_id": "ewcw8ee0-474a-bxxqwqw-06f0b6c44a5",
	"client": "1qwxqwxwq-xqxqw-xqqx-7e28931",
	"experience": "multistep",
	"status": "in-progress",
	"stepsCompleted": 1,
	"totalSteps": 2
   }
 }
| 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. ```json { "event_id": "9dd3c94b-1e7f-4e3e-aee4-092aa119830f", "event_name": "object_created", "timeLimit": { "expiresOn": { "$date": "0001-01-01T00:00:00Z" } }, "status": "pristine", "campaign_id": "a061a170-f31b-4bf3-bc0a-c7639e9d7cfd", "user_id": "glutest-19-oct-1", "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2", "activity": { "count": 2, "activities": [{ "limits": { "campaign": 1, "daily": 1 }, "completedCount": { "campaign": 0, "daily": 0 }, "status": "pending", "activityId": "b1194b6b-c04b-4fd9-bfbc-948fcc0a025f", "eventName": "Transaction Completed" }, { "limits": { "campaign": 1, "daily": 1 }, "completedCount": { "campaign": 0, "daily": 0 }, "status": "pending", "activityId": "a9e28653-1646-4e31-a054-ebcdc2e710c2", "eventName": "CAMPAIGN_COMPLETED" }] }, "programExpiry": { "type": "relative", "expiry": 1667500199, "expired": true }, "experience": "multistep", "timestamp": "2022-11-03T18:30:00Z", "event_properties": { "campaign_id": "a061a170-f31b-4bf3-bc0a-c7639e9d7cfd", "client": "84acf2ac-b2e0-4927-8653-cba2b83816c2", "experience": "multistep", "status": "pristine", "stepsCompleted": 0, "totalSteps": 2 } } ```
event_nameenumType of a particular event."object_created"
event_idstringUUID for the eventUUID
statusenumDescribes the state of the action"pristine", "clicked", "completed", "in-progress"
campaign_idstringThis represents an instance of the campaign.Any String Value
user_idstringUser Identification.Any String Value
clientstringThis represents an instance of the clientAny String Value
experienceenumType of activity"spinthewheel","slotmachine","scratchcard","direct","memorygame","quiz","referral","multistep","streak","activity-scratchcard","collectthestamps","gamechallenge","unity","tossthecoin","rollthedice","unitygame","giftbox"
expiryenumType of campaign validity"absolute", "relative", "never"
timestampISO timestampTimestamp of the eventAny Timestamp value
statusstringstatus of campaign"pristine", "clicked", "completed", "in-progress"
event_properties.stepsCompletednumberNumber of steps completedAny Number
event_properties.totalStepsnumberTotal number of steps in campaignAny Number
limits.campaignnumberTotal limit for completing activityAny Number
limits.dailynumberTotal Daily limit for completing activityAny Number
completedCount.campaignnumberActivity Completed per campaignAny Number
completedCount.dailynumberActivity Completed todayAny Number
activitiesarray of objectsList of all activities in a campaign
limitsnumbera number of times the user can perform this activity.Any Integer Value
completedCountnumberCount of completed activities from the set limitAny Integer Value
campaignnumberCampaign level limit for the activityAny Integer Value
dailynumberThe daily limit for the activityAny Integer Value
statusstringstatus of activityAny of the following
activityIdstringuniqueID for activityString ID Specified During campaign creation.
eventNamestringName of the event send to complete activityAny String value
completedOnstringDate of completionAny Date value
timeLimitobject
expiresOn.$dateISO timestamptime of expiration for campaign
programExpiryobject
typestringtype of expiration modeAny of the following 1. absolute 2. relative 3. never
expiryUnix timestampUnix timestamp for program expiryAny Timestamp
expiredboolflag to specify if a program is expiredAny bool value
### Activity Step Completed Triggered when a user completes a sub-step of an activity (also triggered for steps of streaks) ```json { "eventId": "2502c138-b292-4ba8-98bf-a535ddacc00d", "event_name": "sub_step_completed", "status": "in-progress", "campaignId": "d0c6fd39-8d86-4086-be39-17abb52c82fc", "user_id": "kaushalpadaliya45@gmail.com", "client": "34dc2ebc-819c-423d-85a1-9d22e788a934", "activity": { "count": 1, "activities": [{ "limits": { "campaign": 7, "daily": 1 }, "completedCount": { "campaign": 1, "daily": 1 }, "status": "in-progress", "activityId": "235bd50b-3246-41a7-a0d6-1d66432f2412", "eventName": "SkillUp Consumption", "completedOn": { "$date": "2022-10-17T16:03:19Z" } }] }, "experience": "streak", "totalSteps": 1, "timestamp": "2022-10-17T10:33:20Z", "event_properties": { "campaign_id": "d0c6fd39-8d86-4086-be39-17abb52c82fc", "client": "34dc2ebc-819c-423d-85a1-9d22e788a934", "experience": "streak", "status": "in-progress", "stepsCompleted": 0, "totalSteps": 1 } } ``` | 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 |
activityobject
countnumberCount of total activitiesAny Integer Value
activitiesarray of objectsList of all activities in a campaign
limitsnumbera number of times the user can perform this activity.Any Integer Value
completedCountnumberCount of completed activities from the set limitAny Integer Value
campaignnumberCampaign level limit for the activityAny Integer Value
dailynumberThe daily limit for the activityAny Integer Value
statusstringstatus of activityAny of the following
activityIdstringuniqueID for activityString ID Specified During campaign creation.
eventNamestringName of the event send to complete activityAny String value
completedOnstringDate of completionAny Date value
### Campaign Expired Triggered when a multistep/game challenge campaign expires for a user. ```json { "event_name": "CAMPAIGN_EXPIRED", "event_id": "018a34b1-71bb-4022-b410-cd0b015f136d", "client": "c6a4681d-5599-4ba3-bb7c-2XXXXXb", "user_id": "glutest-realUser", "analytics_version": "3.0.0", "timestamp": "2022-09-05T07:27:25.852Z", "event_properties": { "campaign_details": { "campaign_expiry": "2022-09-05T07:27:25.852Z", "campaign_id": "6b81a527-fd14-48b9-932a-6d3c1bc9f2XX", "campaign_name": "Campaign name configured by the client", "campaign_expiration_type": "RELATIVE", "campaign_expired": true, "campaign_experience": "MEMORYGAME", "campaign_state": "RUNNING" } } } ```
NameTypeDescriptionValues
event_namestringName of the event"CAMPAIGN_EXPIRED"
event_idUUIDID for eventUUID
clientstringclient IDUUID
user_idstringuser ID for the eventuserID string
analytics_versionstringversion of the eventversion string
timestamptimestamptimestamp of the eventAny timestamp
event_propertiesobjectaddtional event propertiescampaign_details object
campaign_expirytimestamptimestamp of event expiryAny timestamp
campaign_idstringcampaign ID Any string
campaign_namestringName of the campaignAny string
campaign_expiration_typeenumType of expiration logic"ABSOLUTE" "RELATIVE"
campaign_expiredbooleanflag for campaign expiration objectboolean
campaign_experienceenumexperience of the campaign"MEMORYGAME" , "QUIZ" , "SPINTHEWHEEL" , "SCRATCHCARD" , "SLOTMACHINE" , "GIFTBOX" , "ROLLTHEDICE" , "SWIPEUI", "TOSSTHECOIN"
campaign_stateenumGlobal status of the campaign"RUNNING" "STOPPED"