Tenant.setupRequested
Emitted each time a Tenant is setupRequested.
Tenant.requestSetup emits Tenant.setupRequested when it completes on a Tenant.
| Property | Value |
|---|---|
| Emitted by | Tenant.requestSetup |
| Noun | Tenant |
| Wakes | None. |
Payload
Each delivery is an Event record. data holds what Tenant.requestSetup returns.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | required | Tenant.setupRequested. |
at | datetime | required | When it happened. |
seq | integer | Its position in the namespace, one more than the Event before; any seq is a cursor into the history. | |
data | json | required | The Thing as the Action left it. |
data.link | url | required | The single-use setup link, valid for 7 days. |
data.tenant | Tenant | required | The Tenant being set up. |
data.tenant.placement | string | Where the Tenant sits in an address: path or host. | |
data.tenant.apiVersion | string | The API version an unversioned call with this Tenant’s keys answers at; set at creation, moved only by pin. |
Example
{
"$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
}