referral.payout_recorded
The creator recorded that they paid an affiliate.
When this fires
The creator recorded a payout against an affiliate, in one currency, from whichever surface they used. The amount is checked against what the affiliate is owed in that currency, then the oldest payable commissions are marked paid while the amount lasts; rewards_paid says how many it covered.
Subscriby moved no money. The payout is the creator's own statement that money left, however they agreed to pay the affiliate.
Caveats
- A payout above the balance is refused and emits nothing, as is one of nothing.
- A clawback is paid too. A negative row is covered in its turn, which is how a refund after a payout nets off against the next one.
Related events
referral.reward_approved: what becomes payable.referral.reward_reversed: what gets netted off.
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