Webhook Document

Data sent with the Webhook POST requests -

Scratch Card Generated

{
"type": "action_event",
"name": "scratch_card_generated",
"campaign_id": 123,
"ext_user_id": "123445",
"ref_num": "MNCLNDS",
"user_event_key": "event_key",
"reward_value": 10,
"wallet_type_id": 1,
"created_at": 1605179895
}

User Wallet Credit

{
"type": "action_event",
"name": "user_wallet_credit",
"id": 12,
"value": 10,
"ref_num": "NCMVN",
"credit_reason": "Reason for Credit",
"wallet_type_id": 1,
"user_event_key": "event_key",
"ext_user_id": "12345",
"created_at": 1605179895
}

User Wallet Debit

{
"type": "action_event",
"name": "user_wallet_debit",
"id": 12,
"value": 10,
"ref_num": "NCMVN",
"debit_reason": "Reason for Debit",
"wallet_type_id": 1,
"user_event_key": "event_key",
"ext_user_id": "12345",
"created_at": 1605179895
}

Referral Reward Generated

{
"type": "action_event",
"name": "successful_user_referral",
"ext_user_id": "12345",
"referrer_ext_user_id": "12345",
"created_at": 12132432545
}

Referral Reward Not Generated

{
"type": "action_event",
"name": "referral_reward_not_generated",
"ext_user_id": "12345",
"referrer_ext_user_id": "12345"
}

Gift Card Redeemed

{
"type": "action_event",
"name": "gift_card_redeemed",
"ext_user_id": "12345",
"gift_card_value": 10,
"amount_spent": 1000,
"wallet_type": "Points"
}

Campaign Budget Reached

{
"type": "action_event",
"name": "campaign_budget_reached",
"campaign_id": 123,
"budget": 1000,
"wallet_type_id": 1
}

Daily Reward Limit Reached

{
“type”: “action_event”,
"name": "daily_reward_limit_reached",
"campaign_id": 123,
"user_id": "12345"
}

Total Reward Limit Reached

{
"type": "action_event",
"name": "total_reward_limit_reached",
"campaign_id": 1,
"ext_user_id": "12345"
}

User Quiz Played

{
  type: "action_event",
  name: "user_quiz_played",
  ext_user_id: ext_uid,
  quiz_tournament_id: id,
  campaign_id: offer_id,
  created_at: 1234567
}

User Quiz Score Recorded

{
  type: "action_event",
  name: "user_quiz_score_recorded", 
  score: score, 
  answers: quiz_answers, 
  ext_user_id: ext_uid,
  quiz_tournament_id: id, 
  campaign_id: offer_id,
  created_at: 1234567
}

Campaign Started

{
  type: "action_event",
  name: "campaign_started", 
  campaign_id: 123, 
  campaign_title: "Campaign Title",
  starts_at: 1234567890, 
  ends_at: 1234567890
}

Campaign Ended

{
  type: "action_event",
  name: "campaign_ended", 
  campaign_id: 123,
  campaign_title: "Campaign Title",
  starts_at: 1234567890,
  ends_at: 1234567890
}

Custom Gift Card Purchased

{
  type: "action_event",
  name: "custom_gift_card_purchased", 
  virtual_currency_used: 123, 
  virtual_currency_label: "Points", 
  ref_num: "ASC123", 
  ext_user_id: "1234DSDS43",
  user_name: "John Doe",
  user_email: "[email protected]",
  product_id: "12SD34", 
  product_name: "Company Coupon", 
  created_at: 1234567890
}

Share Link Clicked

{
  type: "action_event",
  name: "share_link_clicked",
  ext_user_id: "123ASC",
  offer_id: 1,
  created_at: 1234567890
}

User Tournament Played

{
  type: "action_event",
  name: "user_tournament_played",
  ext_user_id: "123ASC", 
  tournament_id: 1, game_id: 1,
  game_name: "Floor Escape", 
  created_at: 1234567890
}

Checkin

{
  type: "action_event", 
  name: "checkin", 
  campaign_id: 1,
  user_event_key: "transact",
  reward_won: true,
  ref_num: "123POI",
  value: 10, 
  wallet_type_id: 1,
  ext_user_id: "123ASC", 
  created_at: 1234567890
}

Payout Updated

{
  type: "action_event", 
  name: "payout_updated",
  ext_user_id: "123ASC",
  payout: {
            utr: "UTR",
            status: "STATUS", 
            amount: 100, 
            payout_mode: "IMPS/NEFT/etc",
            failure_reason: "MESSAGE"
           },
  account: {
            type: "bank/upi", 
            account_number: "ACCOUNT NUMBER",
            name: "NAME",
            ifsc: "IFSC",
            upi_id:"a@upi"
           } 
}

            
                                                                                                      
                                                                                                                               """@upoP

New User Registered

{
  type: "action_event", 
  name: "new_user_registered", 
  ext_user_id: "123ASC",
  referrer_ext_user_id: "456ASC",
  user_referral_code: "ABC245",
  user_referral_link: "URL",
  created_at: 1234567890
}