Message

// Create a message
const message = new Message({
  id: "msg-1",
  threadId: "slack:C123:1234.5678",
  text: "Hello world",
  formatted: parseMarkdown("Hello world"),
  raw: {},
  author: { userId: "U123", userName: "user", fullName: "User", isBot: false, isMe: false },
  metadata: { dateSent: new Date(), edited: false },
  attachments: [],
});

// Serialize for workflow
const serialized = message.toJSON();

Constructor

Message(data: MessageData<TRawMessage>): Message<TRawMessage>

Parameters

MessageData<TRawMessage>

required

Type: MessageData

Returns

Message

Properties

Attachment[]

required

Type: AttachmentAttachments

Author

required

Message author

Root

required

Structured formatting as an AST (mdast Root). This is the canonical representation - use this for processing. Use stringifyMarkdown(message.formatted) to get markdown string.

string

required

Unique message ID

boolean

Whether the bot is @-mentioned in this message.Populated by the Chat SDK before handlers run. An adapter that reads the platform’s own mention metadata reports true or false; the SDK falls back to matching @username in the message text (using the adapter’s configured userName and optional botUserId) only when this is undefined.A definitive false wins over text that merely looks like a mention, such as @username inside a code sample or quoted text.One exception: a direct message received while no onDirectMessage handler is registered is always marked true, whatever the adapter reported, so it routes to onNewMention.

chat.onSubscribedMessage(async (thread, message) => {
  if (message.isMention) {
    await thread.post("You mentioned me!");
  }
});

LinkPreview[]

required

Type: LinkPreviewLinks found in the message

MessageMetadata

required

Message metadata

TRawMessage

required

Platform-specific raw payload (escape hatch)

Message<TRawMessage>

Type: MessageMessage this message replies to

Promise<MessageSubject | null>

required

Type: MessageSubject

string

required

Plain text content (all formatting stripped)

string

required

Thread this message belongs to

string

Cross-platform user key for this message’s author.Set by the Chat SDK before passing the message to handlers, when ChatConfig.identity is configured. undefined if no resolver is configured; undefined (i.e. absent) when the resolver returned null.Used by the Transcripts API to look up / append per-user transcripts.

Methods

WORKFLOW_DESERIALIZE

[WORKFLOW_DESERIALIZE](data: SerializedMessage): Message

Deserialize a Message from @workflow/serde. This static method is automatically called by workflow deserialization.

Parameters

SerializedMessage

required

Returns

Message

WORKFLOW_SERIALIZE

[WORKFLOW_SERIALIZE](instance: Message): SerializedMessage

Serialize a Message instance for @workflow/serde. This static method is automatically called by workflow serialization.

Parameters

Message

required

Returns

SerializedMessage

fromJSON()

fromJSON(json: SerializedMessage): Message<TRawMessage>

Reconstruct a Message from serialized JSON data. Converts ISO date strings back to Date objects.

Parameters

SerializedMessage

required

Returns

Message

toJSON()

toJSON(): SerializedMessage

Serialize the message to a plain JSON object. Use this to pass message data to external systems like workflow engines. Note: Attachment data (Buffer) and fetchData (function) are omitted as they’re not serializable.

Returns

SerializedMessage

Advanced Kits

Opensource Kits

Utilities

Type reference

Constructor

Parameters

Returns

Properties

Methods

WORKFLOW_DESERIALIZE

Parameters

Returns

WORKFLOW_SERIALIZE

Parameters

Returns

fromJSON()

Parameters

Returns

toJSON()

Returns

​Constructor

​Parameters

​Returns

​Properties

​Methods

​WORKFLOW_DESERIALIZE

​Parameters

​Returns

​WORKFLOW_SERIALIZE

​Parameters

​Returns

​fromJSON()

​Parameters

​Returns

​toJSON()

​Returns

Constructor

Parameters

Returns

Properties

Methods

WORKFLOW_DESERIALIZE

Parameters

Returns

WORKFLOW_SERIALIZE

Parameters

Returns

fromJSON()

Parameters

Returns

toJSON()

Returns