Version
WEBHOOK

referral.reward_reversed

A full refund reversed a commission, or clawed back one the creator had already paid.

When this fires

A payment that had earned a commission was fully refunded or charged back, which Subscriby learns from the same gateway event that emits payment.refunded. A row never paid out is reversed in place; a row already paid is answered with a clawback, a second row carrying the negative amount, so the affiliate's balance drops and the creator's next payout nets it off.

A partial refund changes nothing. The creator kept most of the money, and the rule an affiliate can be told is the simple one: only a full refund takes a commission back. Days are never taken back.

Caveats

  • A redelivered refund writes no second clawback. The second delivery finds the rows reversed and the clawback written, and touches nothing.
  • A refund that names its payment touches that payment's commission only. One that names none unwinds every live commission on the subscription, which is what a refund of "the last charge" means.

Related events

  • payment.refunded: the refund this followed.
  • referral.payout_recorded: where a clawback is netted off.

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