Payload
Show properties
Show properties
ID of the reward record.
Status of the reward (e.g.,
approved, pending).Reward amount in the unit’s smallest denomination (e.g., cents for
cash).Unit of the reward (e.g.,
cash, points, free_months, credits).Timestamp of when the reward was created.
ID of the sale or conversion event that triggered this reward.
Sale amount in cents that triggered the reward.
Tier level in a multi-tier program (1 = direct referral, 2 = second tier, etc.).
Split type if the commission was shared between promoters.
The lead whose conversion triggered this reward.
Show properties
Show properties
ID of the lead.
Current state of the lead.
Email address of the lead.
External user ID.
Timestamp of first payment.
Timestamp of cancellation, or
null.Subscription plan name.
Fraud suspicion level.
Timestamp of when the lead was created.
The promoter who earned this reward. See Promoter Signs Up for the full promoter object structure.
The promotion linked to this reward. See Lead Signup for the full promotion object structure.
Example
{
"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",
"event_id": "sale_abc123",
"conversion_amount": 10000,
"tier_level": 1,
"split_type": null,
"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",
"created_at": "2024-10-03T13:45:20.031Z",
"split_promotion_id": null,
"custom_fields": null,
"split_percentage_value": null,
"visitor_sub_id": null
},
"promoter": {
"id": 5779418,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2023-05-03T18:33:55.055Z",
"temp_password": null,
"default_promotion_id": 6250255,
"pref": "wo05sqe",
"default_ref_id": "myrefid",
"note": null,
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": null,
"earnings_balance": { "cash": 4200 },
"current_balance": { "cash": 4200 },
"paid_balance": null,
"auth_token": "RjCBDM8EkjfzzzCgpNBdV6VVLqMfttb",
"profile": {
"id": 5814797,
"first_name": "Ulysses",
"last_name": "Watson",
"website": "",
"company_name": "",
"phone_number": "",
"address": "",
"vat_id": "",
"country": "US",
"paypal_email": null,
"avatar_url": "",
"description": null,
"social_accounts": {
"twitter": { "url": "" },
"youtube": { "url": "" },
"facebook": { "url": "" },
"linkedin": { "url": "" },
"instagram": { "url": "" }
}
},
"promotions": []
},
"promotion": {
"id": 9438768,
"status": "offer_running",
"ref_id": "myrefid",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 5779418,
"campaign_id": 13202,
"referral_link": "https://www.example.com?_get=myrefid",
"current_offer": {
"id": 67212,
"name": "5% discount coupon",
"amount": 5,
"unit": "discount_per",
"default_promo_code": "EXAMPLE-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": null,
"current_target_reward": null,
"campaign_name": "Main Campaign",
"hidden": false,
"visitors_count": 5,
"leads_count": 3,
"customers_count": 2,
"refunds_count": 0,
"cancellations_count": 0,
"sales_count": 2,
"sales_total": 20000,
"refunds_total": 0,
"active_customers_count": 2
}
}
}