referral.* events

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 applied when the member holds an ordinary live membership (the days are banked on it) and pending when they hold nothing live, in which case they wait on the affiliate's balance for their next purchase. A money row is pending behind the programme's hold with hold_until set, or approved at 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.
postWebhookreferral.reward_earned

Headers

SB-Signaturestring required

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

SB-Event-Idstring required

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.

SB-Event-Namestring required

The event name, the same as the envelope's type.

Content-Typestring required

Always application/json.

User-Agentstring required

Always Subscriby-Webhooks/1.0.

Payload

idstring required

A ULID unique to the event, prefixed evt_. Every retry carries the same id, so it is the key to deduplicate on.

type'referral.reward_earned' required

The event name, always referral.reward_earned here.

created_atstring date-time required

When the event was emitted, server time, ISO 8601.

api_versionstring required

The contract version of the payload shape, 2026-05-01 today. A breaking change to a shape ships under a new version.

project_idstring uuid nullable required

The project the event belongs to; null for team-scoped and billing events.

Response

Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.