Webhooks
Reward Created
Copy
{
"event": {
"id": 22737431,
"type": "reward_created",
"created_at": "2024-10-03T14:23:20.791Z"
},
"data": {
"id": 11174868,
"status": "approved",
"amount": 200,
"unit": "cash",
"created_at": "2024-10-03T14:23:20.495Z",
"lead": {
"id": 21381518,
"state": "active",
"email": "[email protected]",
"uid": "",
"customer_since": "2024-10-03T14:23:20.495Z",
"cancelled_at": null,
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-10-03T13:45:20.031Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"event_id": "Sit1234_id",
"conversion_amount": 10000,
"tier_level": 2,
"split_type": null,
"promoter": {
"id": 5779418,
"status": "active",
"cust_id": "Todd Mccormick Plc",
"email": "[email protected]",
"created_at": "2023-05-03T18:33:55.055Z",
"temp_password": "9jCRDdmA",
"default_promotion_id": 6250255,
"pref": "wo05sqe",
"default_ref_id": "gusdc",
"note": null,
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 5772992,
"earnings_balance": {
"cash": 4200,
"credits": 60
},
"current_balance": {
"cash": 4200
},
"paid_balance": {
"credits": 60
},
"auth_token": "-RjCBDM8EkjfzzzCgpNBdV6VVLqMfttb",
"profile": {
"id": 5814797,
"first_name": "Ulysses",
"last_name": "Watson",
"website": "",
"company_name": "",
"phone_number": "",
"address": "",
"vat_id": "",
"country": "PT",
"paypal_email": null,
"avatar_url": "",
"description": null,
"social_accounts": {
"twitter": {
"url": ""
},
"youtube": {
"url": ""
},
"facebook": {
"url": ""
},
"linkedin": {
"url": ""
},
"instagram": {
"url": ""
}
}
},
"promotions": [
{
"id": 6238498,
"status": "offer_inactive",
"ref_id": "u1lxd",
"promo_code": null,
"customer_promo_code": "xyz1234",
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13313,
"referral_link": "http://localhost:3001?fgt=qwert&fpr=u1lxd",
"current_offer": null,
"current_referral_reward": {
"id": 116314,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "10% recurring commission",
"per_of_sale": 10,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 85713,
"amount": 2000,
"type": "per_promotion",
"unit": "cash",
"name": "$20 cash reward",
"per_of_sale": 0,
"default_promo_code": ""
},
"current_target_reward": null,
"campaign_name": "Highlevel Campaign",
"hidden": true,
"visitors_count": 2,
"leads_count": 3,
"customers_count": 3,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 3,
"sales_total": 18000,
"refunds_total": 0,
"active_customers_count": 3
},
{
"id": 9438768,
"status": "offer_running",
"ref_id": "jqagt",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.cax.ws?_get=jqagt",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": " MAXADA-5"
},
"current_referral_reward": {
"id": 128312,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 68347,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"current_target_reward": null,
"campaign_name": "Jaquelyn Ryan",
"hidden": true,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
},
{
"id": 6250255,
"status": "offer_running",
"ref_id": "gusdc",
"promo_code": "rXqBjtPG",
"customer_promo_code": "NEWCOUP",
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13228,
"referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=gusdc",
"current_offer": {
"id": 92509,
"name": "20% discount coupon",
"amount": 20,
"unit": "discount_per",
"default_promo_code": null
},
"current_referral_reward": {
"id": 120200,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": null,
"current_target_reward": null,
"campaign_name": "erSecond FP Campaign",
"hidden": false,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
}
]
},
"promotion": {
"id": 9438768,
"status": "offer_running",
"ref_id": "jqagt",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.cax.ws?_get=jqagt",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": " MAXADA-5"
},
"current_referral_reward": {
"id": 128312,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 68347,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"current_target_reward": null,
"campaign_name": "Jaquelyn Ryan",
"hidden": true,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
}
}
}
By setting up a webhook, your endpoint will receive an event when a reward is generated.
This event is triggered anytime a reward is generated.
Response Paramerters
The Id of the reward
The status of the reward
The reward amount
The unit of the reward
The date and time the reward was created
The Id of the lead
The state of the lead
The email of the lead
The user id of the lead
The date and time the lead became a customer
The date and time the lead was cancelled
The plan name the lead is subscribed to
This states if the addition of the lead is suspected to be fraudulent
The username of the lead
The website of the lead
The date and time the lead was created
The split promotion id of the lead
The split percentage value of the lead
The Id of the event
The conversion amount
The tier level
The split type
The Id of the promoter
The status of the promoter
The customer id of the promoter
The email of the promoter
The date the promoter was created
The temporary password of the promoter
The default promotion id of the promoter
The pref of the promoter
The default referral id of the promoter
The note saved on the promoter profile by an admin
The w8 form url saved on the promoter profile by an admin
The w9 form url saved on the promoter profile by an admin
The parent promoter id of the promoter
The earnings balance of the promoter
The current balance of the promoter
The paid balance of the promoter
The auth token of the promoter
The Id of the profile
The first name of the profile
The last name of the profile
The website of the profile
The company name of the profile
The phone number of the profile
The address of the profile
The vat id of the profile
The country of the profile
The paypal email of the profile
The avatar url of the profile
The description of the profile
The Id of the promotion
The status of the promotion
The referral id of the promotion
The promo code of the promotion
The customer promo code of the promotion
The target reached at of the promotion
The promoter id of the promotion
The campaign id of the promotion
The referral link of the promotion
The Id of the referral reward
The amount of the referral reward
The type of the referral reward
The unit of the referral reward
The name of the referral reward
The per of sale of the referral reward
The default promo code of the referral reward
The Id of the promotion reward
The amount of the promotion reward
The type of the promotion reward
The unit of the promotion reward
The name of the promotion reward
The per of sale of the promotion reward
The default promo code of the promotion reward
The Id of the referral reward
The amount of the referral reward
The type of the referral reward
The unit of the referral reward
The name of the referral reward
The per of sale of the referral reward
The default promo code of the referral reward
The name of the campaign
Whether the campaign is hidden
The number of visitors
The number of leads
The number of customers
The number of refunds
The number of cancellations
The number of sales
The total sales
The total refunds
The number of active customers
Copy
{
"event": {
"id": 22737431,
"type": "reward_created",
"created_at": "2024-10-03T14:23:20.791Z"
},
"data": {
"id": 11174868,
"status": "approved",
"amount": 200,
"unit": "cash",
"created_at": "2024-10-03T14:23:20.495Z",
"lead": {
"id": 21381518,
"state": "active",
"email": "[email protected]",
"uid": "",
"customer_since": "2024-10-03T14:23:20.495Z",
"cancelled_at": null,
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-10-03T13:45:20.031Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"event_id": "Sit1234_id",
"conversion_amount": 10000,
"tier_level": 2,
"split_type": null,
"promoter": {
"id": 5779418,
"status": "active",
"cust_id": "Todd Mccormick Plc",
"email": "[email protected]",
"created_at": "2023-05-03T18:33:55.055Z",
"temp_password": "9jCRDdmA",
"default_promotion_id": 6250255,
"pref": "wo05sqe",
"default_ref_id": "gusdc",
"note": null,
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 5772992,
"earnings_balance": {
"cash": 4200,
"credits": 60
},
"current_balance": {
"cash": 4200
},
"paid_balance": {
"credits": 60
},
"auth_token": "-RjCBDM8EkjfzzzCgpNBdV6VVLqMfttb",
"profile": {
"id": 5814797,
"first_name": "Ulysses",
"last_name": "Watson",
"website": "",
"company_name": "",
"phone_number": "",
"address": "",
"vat_id": "",
"country": "PT",
"paypal_email": null,
"avatar_url": "",
"description": null,
"social_accounts": {
"twitter": {
"url": ""
},
"youtube": {
"url": ""
},
"facebook": {
"url": ""
},
"linkedin": {
"url": ""
},
"instagram": {
"url": ""
}
}
},
"promotions": [
{
"id": 6238498,
"status": "offer_inactive",
"ref_id": "u1lxd",
"promo_code": null,
"customer_promo_code": "xyz1234",
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13313,
"referral_link": "http://localhost:3001?fgt=qwert&fpr=u1lxd",
"current_offer": null,
"current_referral_reward": {
"id": 116314,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "10% recurring commission",
"per_of_sale": 10,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 85713,
"amount": 2000,
"type": "per_promotion",
"unit": "cash",
"name": "$20 cash reward",
"per_of_sale": 0,
"default_promo_code": ""
},
"current_target_reward": null,
"campaign_name": "Highlevel Campaign",
"hidden": true,
"visitors_count": 2,
"leads_count": 3,
"customers_count": 3,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 3,
"sales_total": 18000,
"refunds_total": 0,
"active_customers_count": 3
},
{
"id": 9438768,
"status": "offer_running",
"ref_id": "jqagt",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.cax.ws?_get=jqagt",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": " MAXADA-5"
},
"current_referral_reward": {
"id": 128312,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 68347,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"current_target_reward": null,
"campaign_name": "Jaquelyn Ryan",
"hidden": true,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
},
{
"id": 6250255,
"status": "offer_running",
"ref_id": "gusdc",
"promo_code": "rXqBjtPG",
"customer_promo_code": "NEWCOUP",
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13228,
"referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=gusdc",
"current_offer": {
"id": 92509,
"name": "20% discount coupon",
"amount": 20,
"unit": "discount_per",
"default_promo_code": null
},
"current_referral_reward": {
"id": 120200,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": null,
"current_target_reward": null,
"campaign_name": "erSecond FP Campaign",
"hidden": false,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
}
]
},
"promotion": {
"id": 9438768,
"status": "offer_running",
"ref_id": "jqagt",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.cax.ws?_get=jqagt",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": " MAXADA-5"
},
"current_referral_reward": {
"id": 128312,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 68347,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"current_target_reward": null,
"campaign_name": "Jaquelyn Ryan",
"hidden": true,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
}
}
}
Copy
{
"event": {
"id": 22737431,
"type": "reward_created",
"created_at": "2024-10-03T14:23:20.791Z"
},
"data": {
"id": 11174868,
"status": "approved",
"amount": 200,
"unit": "cash",
"created_at": "2024-10-03T14:23:20.495Z",
"lead": {
"id": 21381518,
"state": "active",
"email": "[email protected]",
"uid": "",
"customer_since": "2024-10-03T14:23:20.495Z",
"cancelled_at": null,
"plan_name": null,
"suspicion": "no_suspicion",
"username": null,
"website": null,
"created_at": "2024-10-03T13:45:20.031Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"event_id": "Sit1234_id",
"conversion_amount": 10000,
"tier_level": 2,
"split_type": null,
"promoter": {
"id": 5779418,
"status": "active",
"cust_id": "Todd Mccormick Plc",
"email": "[email protected]",
"created_at": "2023-05-03T18:33:55.055Z",
"temp_password": "9jCRDdmA",
"default_promotion_id": 6250255,
"pref": "wo05sqe",
"default_ref_id": "gusdc",
"note": null,
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": 5772992,
"earnings_balance": {
"cash": 4200,
"credits": 60
},
"current_balance": {
"cash": 4200
},
"paid_balance": {
"credits": 60
},
"auth_token": "-RjCBDM8EkjfzzzCgpNBdV6VVLqMfttb",
"profile": {
"id": 5814797,
"first_name": "Ulysses",
"last_name": "Watson",
"website": "",
"company_name": "",
"phone_number": "",
"address": "",
"vat_id": "",
"country": "PT",
"paypal_email": null,
"avatar_url": "",
"description": null,
"social_accounts": {
"twitter": {
"url": ""
},
"youtube": {
"url": ""
},
"facebook": {
"url": ""
},
"linkedin": {
"url": ""
},
"instagram": {
"url": ""
}
}
},
"promotions": [
{
"id": 6238498,
"status": "offer_inactive",
"ref_id": "u1lxd",
"promo_code": null,
"customer_promo_code": "xyz1234",
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13313,
"referral_link": "http://localhost:3001?fgt=qwert&fpr=u1lxd",
"current_offer": null,
"current_referral_reward": {
"id": 116314,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "10% recurring commission",
"per_of_sale": 10,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 85713,
"amount": 2000,
"type": "per_promotion",
"unit": "cash",
"name": "$20 cash reward",
"per_of_sale": 0,
"default_promo_code": ""
},
"current_target_reward": null,
"campaign_name": "Highlevel Campaign",
"hidden": true,
"visitors_count": 2,
"leads_count": 3,
"customers_count": 3,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 3,
"sales_total": 18000,
"refunds_total": 0,
"active_customers_count": 3
},
{
"id": 9438768,
"status": "offer_running",
"ref_id": "jqagt",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.cax.ws?_get=jqagt",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": " MAXADA-5"
},
"current_referral_reward": {
"id": 128312,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 68347,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"current_target_reward": null,
"campaign_name": "Jaquelyn Ryan",
"hidden": true,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
},
{
"id": 6250255,
"status": "offer_running",
"ref_id": "gusdc",
"promo_code": "rXqBjtPG",
"customer_promo_code": "NEWCOUP",
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13228,
"referral_link": "https://resilient-pegasus-e7ed60.netlify.app?fpr=gusdc",
"current_offer": {
"id": 92509,
"name": "20% discount coupon",
"amount": 20,
"unit": "discount_per",
"default_promo_code": null
},
"current_referral_reward": {
"id": 120200,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": null,
"current_target_reward": null,
"campaign_name": "erSecond FP Campaign",
"hidden": false,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
}
]
},
"promotion": {
"id": 9438768,
"status": "offer_running",
"ref_id": "jqagt",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.cax.ws?_get=jqagt",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": " MAXADA-5"
},
"current_referral_reward": {
"id": 128312,
"amount": 0,
"type": "per_referral",
"unit": "cash",
"name": "20% recurring commission",
"per_of_sale": 20,
"default_promo_code": ""
},
"current_promotion_reward": {
"id": 68347,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"current_target_reward": null,
"campaign_name": "Jaquelyn Ryan",
"hidden": true,
"visitors_count": 0,
"leads_count": 0,
"customers_count": 0,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 0,
"sales_total": 0,
"refunds_total": 0,
"active_customers_count": 0
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.