LogoLogo
REST APIWebhooksHelp Center →
  • Introduction
  • JavaScript API
    • Overview
  • REST API
    • Overview
    • Campaigns
      • The campaign object
      • List campaigns
      • Create campaign
      • Retrieve campaign
      • Update campaign
    • Affiliates
      • The affiliate object
      • List affiliates
      • Create affiliate
      • Retrieve affiliate
      • Update affiliate
      • Magic Link (SSO)
    • Affiliate Links
      • The affiliate link object
      • List affiliate links
      • Create affiliate link
      • Retrieve affiliate link
      • Update affiliate link
    • Affiliate Coupons
      • The affiliate coupon object
      • List affiliate coupons
      • Create affiliate coupon
      • Retrieve affiliate coupon
    • Referrals
      • The referral object
      • List referrals
    • Commissions
      • The commission object
      • List commissions
      • Retrieve commission
      • Update commission
      • Delete commission
    • Payouts
      • The payout object
      • List payouts
      • Retrieve a payout
      • Mark a payout as paid
  • Webhooks
    • Overview
    • Endpoints
    • Requests
    • Event types
    • Signed webhooks
  • Links
    • Help Center
    • Sign up
    • Login
    • Learn more about Rewardful
Powered by GitBook
On this page
  • Affiliates
  • Affiliate Links
  • Affiliate Coupons
  • Referrals
  • Sales
  • Commissions
  • Payouts

Was this helpful?

Export as PDF
  1. Webhooks

Event types

A complete list of the webhook events Rewardful will send to your endpoints.

PreviousRequestsNextSigned webhooks

Last updated 1 month ago

Was this helpful?

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 for a full example of the data structure posted to your endpoint.

Affiliates

The object key for these events will describe an 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 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.

Affiliate Coupons

The object key for these events will describe an object.

Event name
Description

affiliate_coupon.created

Occurs when an affiliate coupon is created.

affiliate_coupon.updated

Occurs when an affiliate coupon is updated.

affiliate_coupon.activated

Occurs when an affiliate coupon is activated again, after deactivation.

affiliate_coupon.deactivated

Occurs when an affiliate coupon is deactivated.

affiliate_coupon.deleted

Occurs when an affiliate coupon 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

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.voided

Occurs when a commission is voided.

commission.deleted

Occurs when a commission is deleted.

Payouts

Event name
Description

payout.created

Occurs when a new payout is created.

payout.updated

Occurs when a payout is updated.

payout.due

Occurs when a payout is due.

payout.paid

Occurs when a payout is paid.

payout.deleted

Occurs when a payout is deleted.

payout.failed

Occurs when a payout fails.

The object key for these events will describe a object.

The object key for these events will describe a object.

Webhook Requests
affiliate
affiliate_link
affiliate_coupon
commission
payout