Skip to main content

Text object

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

Defines an object containing some text.

Formatted either as plain_text or using mrkdwn, our proprietary contribution to the much beloved Markdown standard.

Fields

FieldTypeDescriptionRequired?
typeStringThe formatting to use for this text object. Can be one of plain_textor mrkdwn.Required
textStringThe text for the block. This field accepts any of the standard text formatting markup when type is mrkdwn. The minimum length is 1 and maximum length is 3000 characters.Required
emojiBooleanIndicates whether emojis in a text field should be escaped into the colon emoji format. This field is only usable when type is plain_text.Optional
verbatimBooleanWhen set to false (as is default) URLs will be auto-converted into links, conversation names will be link-ified, and certain mentions will be automatically parsed. When set to true, Slack will continue to process all markdown formatting and manual parsing strings, but it won’t modify any plain-text content. For example, channel names will not be hyperlinked. This field is only usable when type is mrkdwn.

Example

{
"type": "mrkdwn",
"text": "A message *with some bold text* and _some italicized text_."
}