referral.* events

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.
postWebhookreferral.payout_recorded

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.payout_recorded' required

The event name, always referral.payout_recorded 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.