Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Events

Mailbox.retired

Emitted each time a Mailbox is retired.

Mailbox.retire emits Mailbox.retired when it completes on a Mailbox.

PropertyValue
Emitted byMailbox.retire
NounMailbox
MovesMailbox warming to retired; Mailbox active to retired; Mailbox resting to retired
WakesNone.

Payload

Each delivery is an Event record. data holds what Mailbox.retire returns, and previous holds the state it left.

FieldTypeRequiredDescription
namestringrequiredMailbox.retired.
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.mailboxMailboxrequiredThe retired Mailbox.
data.mailbox.mediumstringrequiredThe platform type, such as email, sms, or chat.
data.mailbox.organizationOrganizationThe outside Organization the Channel is shared with; its new Messages open Conversations for that Customer.
data.mailbox.externalbooleanTrue when people from another Organization post in it, as in a channel two companies share.
data.mailbox.areaCodestringFor an sms Channel, the phone area code its number is drawn from, such as 512.
data.mailbox.numberstringFor an sms Channel, its phone number in international form, assigned when it is created.
data.mailbox.addressemailrequiredThe email address.
data.mailbox.streamstringrequiredWhat it sends: receipts and resets, broadcasts, or cold outbound; one stream per Mailbox.
data.mailbox.dailyCapintegerSends allowed today, raised by the warmup ramp and cut by the brakes.
data.mailbox.statusstringWhere the Mailbox stands in its warmup and rest cycle.
data.mailbox.tenantTenantThe Tenant it sends for, at a Domain that Tenant’s Customer holds; replies land in the Tenant’s Threads.
data.previous.statusstringrequiredThe status before this Event: warming.

Example

JSON
{
  "$id": "https://api.sb/tutorloop.com/events/event_1",
  "$type": "Event",
  "name": "Mailbox.retired",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "mailbox": {
      "$id": "https://api.sb/tutorloop.com/mailboxes/mailbox_1",
      "$type": "Mailbox",
      "medium": "email",
      "organization": "organization_1",
      "external": true,
      "areaCode": "Example area code",
      "number": "Example number",
      "address": "malik@tutorloop.com",
      "stream": "transactional",
      "dailyCap": 1,
      "status": "retired",
      "tenant": "tenant_1"
    },
    "previous": {
      "status": "warming"
    }
  },
  "seq": 1
}