Version
WEBHOOK

partner.payout_recorded

Subscriby recorded a cash payout to the partner.

When this fires

Subscriby paid a partner who chose a cash rail and recorded it: payouts run monthly for balances of $50 or more, by PayPal, Wise, Remitly or USDT, to the details the partner saved, less the rail's own transfer fee. The amount is checked against what the partner is owed, then the oldest payable rows are marked paid while the amount lasts; rewards_paid says how many it covered, clawbacks included.

Caveats

  • The payout details never travel. Where the money went, a PayPal email, a wallet address or the bank account a Wise or Remitly transfer was made to, is stored encrypted on the partner's account and appears in no event.
  • A payout above the balance is refused and emits nothing, as is one to a partner who chose Subscriby Credit.

Related events

  • partner.reward_approved: what becomes payable.
  • partner.reward_reversed: what gets 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