Version
WEBHOOK

partner.reward_approved

A held commission's hold passed and it is now payable.

When this fires

The hourly sweep found a commission past its hold_until on a referral that is not under review, and marked it payable. Fires once per row.

Caveats

  • Payable is not paid. A partner on Subscriby Credit is credited in the same run, which partner.reward_credited announces; a partner paid in cash waits for the monthly run, which pays balances from $50 and announces partner.payout_recorded.
  • The sweep runs hourly, so a row becomes payable up to an hour after hold_until.
  • A referral still under review approves nothing. Its rows wait, past their hold, until Subscriby decides the review.

Related events

  • partner.reward_credited: settled as Subscriby Credit.
  • partner.payout_recorded: settled in cash.

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