recovery.operation_started

A recovery began: run by the creator, by the platform on their behalf, or on demand for a healthy resource.

Ability to subscribeproject-recovery:view

When this fires

The moment a recovery is opened in the ledger: an account relink or a switch to the backup account, a bot replacement, or a channel swap. The row exists from this moment because it is the quota ledger too: the allowance is spent here, and given back only if the recovery fails before changing anything.

A channel recovery absorbs every swap made inside its grace period into one operation, so a second channel swapped an hour after the first fires no second start; it fires recovery.resource_replaced under the same operation_id.

Caveats

  • Once per operation. Swaps absorbed into a running channel recovery fire no second start.
  • A recovery refused before the ledger row is written (quota spent, not the owner, plan lacks the feature) fires nothing.

Related events

  • recovery.operation_completed, recovery.operation_failed: how it ends.

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/recovery.operation_started

How is this guide?