Event types

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
affiliate.created
Occurs when an affiliate signs up for your program, or is created through the Rewardful dashboard or API.
affiliate.confirmed
Occurs when an affiliate successfully confirms their email address.
affiliate.updated
Occurs when an affiliate's details are updated.
affiliate.deleted
Occurs when an affiliate is deleted.
Affiliate Links
The object key for these events will describe an affiliate_link object.
Event name
Description
affiliate_link.created
Occurs when an affiliate link is created.
affiliate_link.updated
Occurs when an affiliate link is updated.
affiliate_link.deleted
Occurs when an affiliate link is deleted.
Referrals
The object key for these events will describe a referral object.
Event name
Description
referral.created
Occurs when a referral is created.
referral.lead
Occurs when a referral transitions to a "lead" state.
referral.converted
Occurs when a referral transitions to a "conversion" state (i.e. paid customer).
referral.deleted
Occurs when a referral is deleted.
Sales
The object key for these events will describe a sale object.
Event name
Description
sale.created
Occurs when a sale is created.
sale.updated
Occurs when a sale is updated.
sale.refunded
Occurs when a sale is refunded.
sale.deleted
Occurs when a sale is deleted.
Commissions
The object key for these events will describe a commission object.
Event name
Description
commission.created
Occurs when a new commission is created.
commission.updated
Occurs when a commission is updated.
commission.paid
Occurs when a commission is paid.
commission.deleted
Occurs when a commission is deleted.

Webhooks - Previous

Requests

Next - Webhooks

Signed webhooks

Last modified 4mo ago

Export as PDF

Copy link

Outline