referral.reward_earned
A settled payment earned a referrer, or the referred friend, days or money.
When this fires
The ledger recorded a settled payment that a live referral earns on: the conversion earns the referrer their days or their first commission and the friend their welcome days; every later payment inside the period earns a percentage referrer another commission. One event per reward row, so a conversion on a programme with a friend reward emits two.
Days land at once, money waits. A days row is
appliedwhen the member holds an ordinary live membership (the days are banked on it) andpendingwhen they hold nothing live, in which case they wait on the affiliate's balance for their next purchase. A money row ispendingbehind the programme's hold withhold_untilset, orapprovedat once when the hold is zero.
Caveats
- A redelivered payment earns nothing twice. The ledger records a payment once, and a payment that already earned a row writes no second one.
- A friend's days need a purchase that can carry them. A pass or a season cannot be moved, so a friend who converts on one receives no days row at all rather than one that never applies.
- Days are never reversed. A refund unwinds money rows only; days already banked stay banked.
Related events
referral.reward_approved: the hold passes.referral.reward_reversed: a refund takes it back.payment.succeeded: the payment itself, from the gateway's side.
Ability to subscribe
A token needs this to subscribe an endpoint to the event.
Header Parameters
t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.
The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.
The event name, the same as the envelope's type.
Always application/json.
Always Subscriby-Webhooks/1.0.
Payload
JSONWhat Subscriby posts to your endpointapplication/json
The signed JSON envelope posted to your endpoint.
The envelope every event is delivered in.
Responses
2XXAny success status
Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.
defaultAny other status
Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.
How is this guide?
Last updated on