Skip to content

Tenant.invited

Emitted each time a Tenant is invited.

Tenant.invite emits Tenant.invited when it completes on a Tenant.

PropertyValue
Emitted byTenant.invite
NounTenant
WakesNone.

Payload

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

FieldTypeRequiredDescription
namestringrequiredTenant.invited.
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.personPersonrequiredThe invited Person.
data.tenantTenantrequiredThe Tenant the Person was invited to.
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.invited",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "person": {
      "$id": "https://api.sb/petpantry.shop/people/person_1",
      "$type": "Person",
      "name": "Lena Fischer"
    },
    "tenant": {
      "$id": "https://api.sb/petpantry.shop/tenants/tenant_1",
      "$type": "Tenant",
      "placement": "path",
      "apiVersion": "v2"
    }
  },
  "seq": 1
}