The id or email of the related user. (Optional in case affiliate_id is set).
The id of the related affiliate. (Optional in case user_id is set).
The amount that is paid to the affiliate.
A description for this referral.
A reference for this referral. Usually this would be the transaction ID of the associated purchase.
An id of a different referral you want to associate as a parent.
An custom currency code such as EUR. Please note that the currency will only have effect it is is selected within the settings of AffiliateWP.
Set a referral campaign. This can be a referral you created for a specific project. E.g. Summer Promotion
The context usually is the slug of the payment provider. E.g. fastspring or paypal. You can also use the third-party integration.
Add any kind of data to your referral.
The date and time of creation of the referral. In case nothing is set, the current time is used.
The referral type. E.g.: sale
In case you use a third-party integration, you can also relate specific products to your referral.
The status of your current referral. E.g.: unpaid
Advanced: Register a custom action after this webhook was fired.
(String) Register a custom WordPress hook callback. The value will be called as followed: do_action( $yourdefinedaction, $action_return_data, $request_data )
More available AffiliateWP endpoints
To learn more about a specific endpoint, simply click on it.