Version
WEBHOOK

connector.outage_compensated

A closed connector outage settled: how many members had time banked, how much each received, and how many invites lost during the outage were re-sent.

When this fires

Once per outage, shortly after connector.outage_closed. The settlement runs from the queue: it first re-sends any invite that never reached a member while the connector was refusing the installation (grants_replayed), then, when the outage lasted an hour or more, ended as recovered or replaced, and the project's Outage Compensation setting is on, banks the outage's length on every live purchase that unlocks a place on that connector (members_extended, one member.access_extended each). The creator receives the same summary by email, on their connected account and in the notification centre; it is also the Compensation column of the Recovery History page.

Caveats

  • Fires with members_extended: 0 when the outage was shorter than an hour, ended with an uninstall, or the project switched Outage Compensation off; the creator is not emailed in that case.
  • Money never moves: no charge, refund or renewal date changes. Recurring members receive the time at the end of their membership.

Related events

  • member.access_extended: one per compensated member.
  • connector.outage_closed: the outage this settles.

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