Payload
Show properties
Show properties
ID of the lead.
Current state of the lead (e.g.,
signup, active, cancelled).Email address of the lead.
External user ID you passed when tracking the lead.
Timestamp of when the lead became a paying customer.
null until they convert.Timestamp of when the lead cancelled.
null if not cancelled.Name of the plan the lead is subscribed to.
Fraud suspicion level (e.g.,
no_suspicion, self_referral).Username of the lead, if provided.
Website of the lead, if provided.
Timestamp of when the lead was created.
ID of the split promotion, if applicable.
Percentage split value, if applicable.
The promoter who referred this lead.
Show properties
Show properties
ID of the promoter.
Status of the promoter (e.g.,
active, pending).External customer ID of the promoter.
Email address of the promoter.
Timestamp of when the promoter was created.
Temporary password set on account creation.
ID of the promoter’s default promotion.
Internal preference token for the promoter.
Default referral ID used in links.
Admin note on the promoter’s profile.
URL of the W-8 tax form, if uploaded.
URL of the W-9 tax form, if uploaded.
ID of the parent promoter in a multi-tier setup.
Total commissions earned, broken down by unit (e.g.,
cash, points).Current unpaid balance, broken down by unit.
Total paid out balance, broken down by unit.
Authentication token for the promoter’s affiliate dashboard.
Show properties
Show properties
ID of the profile.
First name.
Last name.
Website URL.
Company name.
Phone number.
Mailing address.
VAT identification number.
Two-letter country code.
PayPal email for payouts.
URL of the promoter’s avatar image.
Bio or description.
Social profile URLs keyed by platform (
twitter, youtube, facebook, linkedin, instagram, tiktok, twitch). Each entry has a url string.Array of promotion objects — one per campaign the promoter is enrolled in. See the promotion object fields below.
The specific promotion (campaign enrollment) that generated this lead.
Show properties
Show properties
ID of the promotion.
Status (e.g.,
offer_running, offer_inactive).Referral ID used in this promotion’s links.
Promoter-facing promo code.
Customer-facing discount code.
Timestamp when the target reward was unlocked.
ID of the promoter.
ID of the campaign.
Full referral URL.
Name of the campaign.
Whether this promotion is hidden from the affiliate dashboard.
Total visitors tracked through this promotion.
Total leads referred.
Total customers converted.
Currently active (non-cancelled) customers.
Total number of sales.
Total sales value in cents.
Total number of refunds.
Total refund value in cents (negative).
Total cancellations.
The active discount offer for referrals.
The active commission reward for this promotion.
The active non-monetary or milestone reward.
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": []
}
}
}