Skip to content

Tenant.setupRequested

Emitted each time a Tenant is setupRequested.

Tenant.requestSetup emits Tenant.setupRequested when it completes on a Tenant.

PropertyValue
Emitted byTenant.requestSetup
NounTenant
WakesNone.

Payload

Each delivery is an Event record. data holds what Tenant.requestSetup returns.

FieldTypeRequiredDescription
namestringrequiredTenant.setupRequested.
atdatetimerequiredWhen it happened.
seqintegerIts position in the namespace, one more than the Event before; any seq is a cursor into the history.
datajsonrequiredThe Thing as the Action left it.
data.linkurlrequiredThe single-use setup link, valid for 7 days.
data.tenantTenantrequiredThe Tenant being set up.
data.tenant.placementstringWhere the Tenant sits in an address: path or host.
data.tenant.apiVersionstringThe API version an unversioned call with this Tenant’s keys answers at; set at creation, moved only by pin.

Example

JSON
{
  "$id": "https://api.sb/petpantry.shop/events/event_1",
  "$type": "Event",
  "name": "Tenant.setupRequested",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "link": "https://petpantry.shop",
    "tenant": {
      "$id": "https://api.sb/petpantry.shop/tenants/tenant_1",
      "$type": "Tenant",
      "placement": "path",
      "apiVersion": "v2"
    }
  },
  "seq": 1
}