Payload
object
object
Show properties
Show properties
number
ID of the lead.
string
Current state of the lead (e.g.,
signup, active, cancelled).string
Email address of the lead.
string
External user ID you passed when tracking the lead.
string
Timestamp of when the lead became a paying customer.
null until they convert.string
Timestamp of when the lead cancelled.
null if not cancelled.string
Name of the plan the lead is subscribed to.
string
Fraud suspicion level:
no_suspicion, same_ip_suspicion, same_promoter_email, or ad_source. same_ip_suspicion and same_promoter_email both indicate a self-referral.string
Username of the lead, if provided.
string
Website of the lead, if provided.
string
Timestamp of when the lead was created.
number
ID of the split promotion, if applicable.
number
Percentage split value, if applicable.
object
The promoter who referred this lead.
Show properties
Show properties
number
ID of the promoter.
string
Status of the promoter (e.g.,
active, pending).string
External customer ID of the promoter.
string
Email address of the promoter.
string
Timestamp of when the promoter was created.
string
Temporary password set on account creation.
number
ID of the promoter’s default promotion.
string
Internal preference token for the promoter.
string
Default referral ID used in links.
string
Admin note on the promoter’s profile.
string
URL of the W-8 tax form, if uploaded.
string
URL of the W-9 tax form, if uploaded.
number
ID of the parent promoter in a multi-tier setup.
object
Total commissions earned, broken down by unit (e.g.,
cash, points).object
Current unpaid balance, broken down by unit.
object
Total paid out balance, broken down by unit.
string
Authentication token for the promoter’s affiliate dashboard.
object
Show properties
Show properties
number
ID of the profile.
string
First name.
string
Last name.
string
Website URL.
string
Company name.
string
Phone number.
string
Mailing address.
string
VAT identification number.
string
Two-letter country code.
string
PayPal email for payouts.
string
URL of the promoter’s avatar image.
string
Bio or description.
object
Social profile URLs keyed by platform (
twitter, youtube, facebook, linkedin, instagram, tiktok, twitch). Each entry has a url string.array
Array of promotion objects — one per campaign the promoter is enrolled in. See the promotion object fields below.
object
The specific promotion (campaign enrollment) that generated this lead.
Show properties
Show properties
number
ID of the promotion.
string
Status (e.g.,
offer_running, offer_inactive).string
Referral ID used in this promotion’s links.
string
Promoter-facing promo code.
string
Customer-facing discount code.
string
Timestamp when the target reward was unlocked.
number
ID of the promoter.
number
ID of the campaign.
string
Full referral URL.
string
Name of the campaign.
boolean
Whether this promotion is hidden from the affiliate dashboard.
number
Total visitors tracked through this promotion.
number
Total leads referred.
number
Total customers converted.
number
Currently active (non-cancelled) customers.
number
Total number of sales.
number
Total sales value in cents.
number
Total number of refunds.
number
Total refund value in cents (negative).
number
Total cancellations.
object
The active discount offer for referrals.
object
The active commission reward for this promotion.
object
The active non-monetary or milestone reward.
object
The active target-based reward, if set.
Example
{
"event": {
"id": 22736304,
"type": "lead_signup",
"created_at": "2024-10-03T13:45:20.103Z"
},
"data": {
"id": 21381518,
"state": "signup",
"email": "goqucugo@mailinator.com",
"uid": "",
"customer_since": null,
"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,
"promotion": {
"id": 4210924,
"status": "offer_running",
"ref_id": "afpxunub",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 3920164,
"campaign_id": 13202,
"referral_link": "https://www.example.com?_get=afpxunub",
"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": 2,
"leads_count": 4,
"customers_count": 3,
"refunds_count": 1,
"cancellations_count": 1,
"sales_count": 3,
"sales_total": 201000,
"refunds_total": -1000,
"active_customers_count": 2
},
"promoter": {
"id": 3920164,
"status": "active",
"cust_id": "",
"email": "promoter@example.com",
"created_at": "2022-04-26T15:28:24.800Z",
"temp_password": null,
"default_promotion_id": 4210919,
"pref": "db1znwe",
"default_ref_id": "myrefid",
"note": null,
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": null,
"earnings_balance": { "cash": 50744 },
"current_balance": { "cash": 20044 },
"paid_balance": { "cash": 30700 },
"auth_token": "hjsmLQwMounBWxeqQS2cMXYp8epADJmB",
"profile": {
"id": 3947800,
"first_name": "Jane",
"last_name": "Smith",
"website": "https://janesmith.com",
"company_name": "",
"phone_number": "",
"address": "",
"vat_id": "",
"country": "US",
"paypal_email": "",
"avatar_url": "",
"description": null,
"social_accounts": {
"twitter": { "url": "" },
"youtube": { "url": "" },
"facebook": { "url": "" },
"linkedin": { "url": "" },
"instagram": { "url": "" }
}
},
"promotions": []
}
}
}