Back to Subscriby

connector.outage_closed

A connector outage ended: the installation answered again, another one took its place, or the creator uninstalled the connector.

Ability to subscribeproject-connector:view

When this fires

An open outage on a project's installation ended. ended_by says how: recovered when the probe found the installation healthy again or the creator reconnected it, replaced when another installation took over (a standby bot failed over, or the creator relinked a new bot), uninstalled when the creator removed the connector while the outage ran. Plans that were off sale return to sale at once.

The settlement follows from the queue and announces itself as connector.outage_compensated: invites that never reached a member during the outage are re-sent, and, when the outage lasted an hour or more, ended as recovered or replaced, and the project's Outage Compensation setting is on, every member whose paid access overlapped it has the outage's length banked on their purchase, one member.access_extended each. How the banked time reaches a member is described in Connector outages.

Caveats

  • An uninstalled end compensates nobody: the uninstall's own preview and opt-ins settle what members get.
  • Outages shorter than an hour end with this event too, but earn no compensation.

Related events

  • connector.outage_opened: the outage began.
  • connector.outage_compensated: the settlement that follows this event.
  • connector.connected: a fresh connection that ends a recovered outage.
  • connector.uninstalled: the uninstall behind an uninstalled end.

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.

Request Body

application/json

The signed JSON envelope posted to your endpoint.

TypeScript Definitions

Use the request body type in TypeScript.

The envelope every event is delivered in.

Response Body

Example Requests

POST/connector.outage_closed

How is this guide?

connector.outage_opened Webhook

A platform refused a project's live installation (token revoked or regenerated, bot deleted) and the connector entered an outage.

connector.outage_compensated Webhook

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.