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
Name | Type | Description |
event | string | Event type that has occured. |
webhook_timestamp | number | Unix timestamp for the event that has occured. |
webhook_date | date | Rendered date taken from webhook_timestamp. |
webhook_time | time | Rendered time taken from webhook_timestamp. |
affiliate_id | number | Affiliate ID for the event that has occured. |
username | string | Affiliate username for the event that has occured. |
first_name | string | Affiliate first name for the event that has occured. |
last_name | string | Affiliate last name for the event that has occured. |
string | Affiliate email address for the event that has occured. | |
order_number | string | Order number for the event that has occured. |
commission_amount | string | Commission amount for the event that has occured. |
sale_amount | string | Sale amount for the event that has occured. |
currency | string | Currency for the event that has occured. |
cart_integration | string | Cart integration for the event that has occured. |
tid_1 | string | TID 1 for the event that has occured. |
tid_2 | string | TID 2 for the event that has occured. |
tid_3 | string | TID 3 for the event that has occured. |
tid_4 | string | TID 4 for the event that has occured. |
sub_id | string | Sub ID for the event that has occured. |
commission_timestamp | number | Unix timestamp for the commission as it was created. |
commission_date | date | Rendered date taken from commission_timestamp. |
commission_time | time | Rendered time taken from commission_timestamp. |
Available Webhook Data: payment.completed
Name | Type | Description |
event | string | Event type that has occured. |
webhook_timestamp | number | Unix timestamp for the event that has occured. |
webhook_date | date | Rendered date taken from webhook_timestamp. |
webhook_time | time | Rendered time taken from webhook_timestamp. |
affiliate_id | number | Affiliate ID for the event that has occured. |
username | string | Affiliate username for the event that has occured. |
first_name | string | Affiliate first name for the event that has occured. |
last_name | string | Affiliate last name for the event that has occured. |
string | Affiliate email address for the event that has occured. | |
payment_amount | string | Payment amount for the event that has occured. |
currency | string | Currency for the event that has occured. |
Available Webhook Data: affiliate.created | affiliate.approved | affiliate.terminated
Name | Type | Description |
event | string | Event type that has occured. |
webhook_timestamp | number | Unix timestamp for the event that has occured. |
webhook_date | date | Rendered date taken from webhook_timestamp. |
webhook_time | time | Rendered time taken from webhook_timestamp. |
affiliate_id | number | Affiliate ID for the event that has occured. |
username | string | Affiliate username for the event that has occured. |
first_name | string | Affiliate first name for the event that has occured. |
last_name | string | Affiliate last name for the event that has occured. |
string | Affiliate email address for the event that has occured. | |
payable | string | Payable details for the event that has occured. |
company | string | Company details for the event that has occured. |
address_1 | string | Address information for the event that has occured. |
currency | string | Currency for the event that has occured. |
address_2 | string | Address information for the event that has occured. |
city | string | City information for the event that has occured. |
state | string | State information for the event that has occured. |
zip | string | Zip code information for the event that has occured. |
country | string | Country information for the event that has occured. |
phone | string | Phone information for the event that has occured. |
fax | string | Fax information for the event that has occured. |
website_url | string | Website URL information for the event that has occured. |
ip_address | string | IP address information for the event that has occured. |
payment_method | string | Payment method information for the event that has occured. |
signup_date_timestamp | string | Unix timestamp for the new account as it was created. |
signup_date | string | Rendered date taken from signup_date_timestamp. |
Available Webhook Data: debit.created | debit.removed | debit.settled
Name | Type | Description |
event | string | Event type that has occured. |
webhook_timestamp | number | Unix timestamp for the event that has occured. |
webhook_date | date | Rendered date taken from webhook_timestamp. |
webhook_time | time | Rendered time taken from webhook_timestamp. |
affiliate_id | number | Affiliate ID for the event that has occured. |
username | string | Affiliate username for the event that has occured. |
first_name | string | Affiliate first name for the event that has occured. |
last_name | string | Affiliate last name for the event that has occured. |
string | Affiliate email address for the event that has occured. | |
debit_amount | string | Debit amount for the event that has occured. |
debit_reason | string | Debit reason for the event that has occured. |
debit_timestamp | number | Unix timestamp for the debit as it was created. |
debit_date | date | Rendered date taken from debit_timestamp. |
debit_time | string | Rendered time taken from debit_timestamp. |