Version
WEBHOOK

partner.rate_changed

The partner's commission rate moved, and the reason: a commitment was verified or lapsed, or their paying referrals reached a volume tier.

When this fires

Every time the stored rate changes: the owner verified a commitment (commitment_verified), the owner or the nightly sweep lapsed one (commitment_lapsed), or a conversion carried the partner across a volume tier (volume_tier), whether it converted on its own or the owner cleared it from review. A verification that lands on the cap moves nothing and emits nothing.

Every move reaches every referral still earning, written onto each one's commission_percent. A drop, which only a withdrawn commitment causes, also recalculates the commissions not yet credited or paid out. The partner.referral_converted that crosses a tier carries the rate before the raise, and this event follows it at once.

The paying count the tiers read is every referral that converted, for life: a creator who later cancels, or whose commission months end, still counts, and a refund reverses the commission without un-counting them; only a referral the owner refuses on review is left out. So a volume tier, once reached, is kept.

Caveats

  • The sum can pass the cap on paper. commitment_points and volume_points are the raw points; commission_percent is what is paid.
  • A raise never re-prices a reward already written: it changes what the next invoice of each earning referral pays. A drop re-prices every pending or approved commission at the lower rate, lowering only; a reward written at a rate below the new one keeps its amount, and nothing credited or paid out is touched.

Related events

  • partner.referral_converted: the rate copied onto one referral.
  • partner.reward_earned: what an invoice pays at that rate.

Ability to subscribe

A token needs this to subscribe an endpoint to the event.

Header Parameters

SB-Signature*string

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-Id*string

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-Name*string

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

Content-Type*string

Always application/json.

User-Agent*string

Always Subscriby-Webhooks/1.0.

Payload

JSONWhat Subscriby posts to your endpoint

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