Event types
A complete list of the webhook events Rewardful will send to your endpoints.
This is a list of all the types of events we currently send. When configuring your webhook, you must select the types of events you'd like to receive to your endpoint. To minimize load on your server, we recommend selecting only the event types you actually need.
See Webhook Requests for a full example of the data structure posted to your endpoint.
Affiliates
The object
key for these events will describe an affiliate
object.
Event name | Description |
| Occurs when an affiliate signs up for your program, or is created through the Rewardful dashboard or API. |
| Occurs when an affiliate successfully confirms their email address. |
| Occurs when an affiliate's details are updated. |
| Occurs when an affiliate is deleted. |
Affiliate Links
The object
key for these events will describe an affiliate_link
object.
Event name | Description |
---|---|
| Occurs when an affiliate link is created. |
| Occurs when an affiliate link is updated. |
| Occurs when an affiliate link is deleted. |
Referrals
The object
key for these events will describe a referral
object.
Event name | Description |
| Occurs when a referral is created. |
| Occurs when a referral transitions to a "lead" state. |
| Occurs when a referral transitions to a "conversion" state (i.e. paid customer). |
| Occurs when a referral is deleted. |
Sales
The object
key for these events will describe a sale
object.
Event name | Description |
| Occurs when a sale is created. |
| Occurs when a sale is updated. |
| Occurs when a sale is refunded. |
| Occurs when a sale is deleted. |
Commissions
The object
key for these events will describe a commission
object.
Event name | Description |
| Occurs when a new commission is created. |
| Occurs when a commission is updated. |
| Occurs when a commission is paid. |
| Occurs when a commission is voided. |
| Occurs when a commission is deleted. |
Payouts
The object
key for these events will describe a payout object.
Event name | Description |
| Occurs when a new payout is created. |
| Occurs when a payout is updated. |
| Occurs when a payout is due. |
| Occurs when a payout is paid. |
| Occurs when a payout is deleted. |
| Occurs when a payout fails. |
Last updated