Skip to content
StartupBuilderby Startups.Studio
Business
Changelog
Events

Enrollment.paused

Emitted each time an Enrollment is paused.

Enrollment.pause emits Enrollment.paused when it completes on an Enrollment.

PropertyValue
Emitted byEnrollment.pause
NounEnrollment
MovesEnrollment active to paused
WakesNone.

Payload

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

FieldTypeRequiredDescription
namestringrequiredEnrollment.paused.
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.enrollmentEnrollmentrequiredThe Enrollment, now paused.
data.enrollment.statusstringrequiredWhere the run stands.
data.enrollment.stepstringrequiredThe Sequence step the person is on.
data.enrollment.nextAtdatetimeWhen the next step fires; empty while paused or exited.
data.enrollment.branchesstring[]The branches taken so far, in order.
data.enrollment.exitReasonstringWhy the run ended.
data.previous.statusstringrequiredThe status before this Event: active.

Example

JSON
{
  "$id": "https://api.sb/petpantry.shop/events/event_1",
  "$type": "Event",
  "name": "Enrollment.paused",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "enrollment": {
      "$id": "https://api.sb/petpantry.shop/enrollments/enrollment_1",
      "$type": "Enrollment",
      "status": "paused",
      "step": "Example step",
      "nextAt": "2026-10-22T12:00:00Z",
      "branches": [
        "Example branches"
      ],
      "exitReason": "replied"
    },
    "previous": {
      "status": "active"
    }
  },
  "seq": 1
}