referral.program_updated
A project's Referral Program settings were written, with a field-by-field list of what moved.
When this fires
A creator saved the programme's settings or switched it on or off, from whichever surface they used. A project holds one programme, so the first save creates it and every later save updates it: the first save reports every field in changes, and a switch reports only active.
A paused programme attributes and rewards nothing.
active: falsestops links attributing and payments earning at once; the ledger and the payouts stay readable. A programme whose owner's plan no longer includes the Referral Program behaves the same way without any event, because nothing on the row changed.
Caveats
- An edit never changes what was already earned. Every reward row copies the figures it was priced with, so a lowered rate or a longer hold applies to payments from here on, not to the ledger.
plan_idsis reported, unlike the coupon snapshot. It is part of the programme's shape and changes to it appear inchanges.- Deleting a programme emits nothing. The ledger beneath it stays, and a delete is refused while affiliates are still owed commissions; the creator records their payouts or switches the programme off instead.
Related events
referral.affiliate_joined: the first thing that happens once a programme is live.
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