Skip to content

Message.scheduled

Emitted each time a Message is scheduled.

Message.schedule emits Message.scheduled when it completes on a Message.

PropertyValue
Emitted byMessage.schedule
NounMessage
WakesNone.

Payload

Each delivery is an Event record. data holds what Message.schedule returns.

FieldTypeRequiredDescription
namestringrequiredMessage.scheduled.
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.messageMessagerequiredThe scheduled Message.
data.message.mediumstringrequiredOne of email, sms, voice, or chat.
data.message.directionstringrequiredOne of inbound or outbound.
data.message.bodytextrequiredWhat it says.
data.message.fromstringThe sender: an address, a number, or a Channel id.
data.message.tostringThe recipient: an address, a number, or a Person id.
data.message.subjectstringThe subject line, for email.
data.message.purposestringWhy it goes out, such as onboarding; consent and suppression rules read it.

Example

JSON
{
  "$id": "https://api.sb/routewise.dev/events/event_1",
  "$type": "Event",
  "name": "Message.scheduled",
  "at": "2026-10-22T12:00:00Z",
  "data": {
    "message": {
      "$id": "https://api.sb/routewise.dev/messages/message_1",
      "$type": "Message",
      "medium": "email",
      "direction": "inbound",
      "body": "Example body",
      "from": "Example from",
      "to": "Example to",
      "subject": "Example subject",
      "purpose": "Example purpose"
    }
  },
  "seq": 1
}