Event Data

The request body is a JSON object with the following fields. Each event type is listed below, showing data to be consumed.

Available Webhook Data: commission.created | commission.approved | commission.declined
NameTypeDescription
eventstringEvent type that has occured.
webhook_timestampnumberUnix timestamp for the event that has occured.
webhook_datedateRendered date taken from webhook_timestamp.
webhook_timetimeRendered time taken from webhook_timestamp.
affiliate_idnumberAffiliate ID for the event that has occured.
usernamestringAffiliate username for the event that has occured.
first_namestringAffiliate first name for the event that has occured.
last_namestringAffiliate last name for the event that has occured.
emailstringAffiliate email address for the event that has occured.
order_numberstringOrder number for the event that has occured.
commission_amountstringCommission amount for the event that has occured.
sale_amountstringSale amount for the event that has occured.
currencystringCurrency for the event that has occured.
cart_integrationstringCart integration for the event that has occured.
tid_1stringTID 1 for the event that has occured.
tid_2stringTID 2 for the event that has occured.
tid_3stringTID 3 for the event that has occured.
tid_4stringTID 4 for the event that has occured.
sub_idstringSub ID for the event that has occured.
commission_timestampnumberUnix timestamp for the commission as it was created.
commission_datedateRendered date taken from commission_timestamp.
commission_timetimeRendered time taken from commission_timestamp.
Available Webhook Data: payment.completed
NameTypeDescription
eventstringEvent type that has occured.
webhook_timestampnumberUnix timestamp for the event that has occured.
webhook_datedateRendered date taken from webhook_timestamp.
webhook_timetimeRendered time taken from webhook_timestamp.
affiliate_idnumberAffiliate ID for the event that has occured.
usernamestringAffiliate username for the event that has occured.
first_namestringAffiliate first name for the event that has occured.
last_namestringAffiliate last name for the event that has occured.
emailstringAffiliate email address for the event that has occured.
payment_amountstringPayment amount for the event that has occured.
currencystringCurrency for the event that has occured.
Available Webhook Data: affiliate.created | affiliate.approved | affiliate.terminated
NameTypeDescription
eventstringEvent type that has occured.
webhook_timestampnumberUnix timestamp for the event that has occured.
webhook_datedateRendered date taken from webhook_timestamp.
webhook_timetimeRendered time taken from webhook_timestamp.
affiliate_idnumberAffiliate ID for the event that has occured.
usernamestringAffiliate username for the event that has occured.
first_namestringAffiliate first name for the event that has occured.
last_namestringAffiliate last name for the event that has occured.
emailstringAffiliate email address for the event that has occured.
payablestringPayable details for the event that has occured.
companystringCompany details for the event that has occured.
address_1stringAddress information for the event that has occured.
currencystringCurrency for the event that has occured.
address_2stringAddress information for the event that has occured.
citystringCity information for the event that has occured.
statestringState information for the event that has occured.
zipstringZip code information for the event that has occured.
countrystringCountry information for the event that has occured.
phonestringPhone information for the event that has occured.
faxstringFax information for the event that has occured.
website_urlstringWebsite URL information for the event that has occured.
ip_addressstringIP address information for the event that has occured.
payment_methodstringPayment method information for the event that has occured.
signup_date_timestampstringUnix timestamp for the new account as it was created.
signup_datestringRendered date taken from signup_date_timestamp.
Available Webhook Data: debit.created | debit.removed | debit.settled
NameTypeDescription
eventstringEvent type that has occured.
webhook_timestampnumberUnix timestamp for the event that has occured.
webhook_datedateRendered date taken from webhook_timestamp.
webhook_timetimeRendered time taken from webhook_timestamp.
affiliate_idnumberAffiliate ID for the event that has occured.
usernamestringAffiliate username for the event that has occured.
first_namestringAffiliate first name for the event that has occured.
last_namestringAffiliate last name for the event that has occured.
emailstringAffiliate email address for the event that has occured.
debit_amountstringDebit amount for the event that has occured.
debit_reasonstringDebit reason for the event that has occured.
debit_timestampnumberUnix timestamp for the debit as it was created.
debit_datedateRendered date taken from debit_timestamp.
debit_timestringRendered time taken from debit_timestamp.