referral.* events

A member joined the Referral Program and was handed a code.

When this fires

A member asked to join from the portal or a connector's bot, or the creator enrolled them by hand. status says where they stand: approved means their code attributes from this moment, pending means the programme requires approval and the creator has been told. A member the creator enrols is approved whatever the programme's switches say.

A code is minted, never chosen. Seven characters from an alphabet without 0, O, 1 or I, unique within the project. The member shares it through the portal link and the deep link of every connector the project runs.

Caveats

  • A member joins once. A second attempt is refused and emits nothing.
  • A customers-only programme refuses a lead. A member with no live membership is refused and emits nothing; nothing in this family announces a refusal.

Related events

  • referral.affiliate_approved: the creator lets a pending affiliate in.
  • referral.captured: their first friend arrives.
postWebhookreferral.affiliate_joined

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

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