Skip to main content

​
Overview

The text element represents a body of text to be rendered inside of the notification. It’s one of the most commonly used elements and supports rich formatting, styling, and can contain inline text content elements (string, link, img) for more complex text structures. When to use:
  • Display body text, paragraphs, and descriptions
  • Create headings and subheadings
  • Show formatted text with styling (bold, italic, colors)
  • Include inline links and images within text
  • Display dynamic content with Handlebars variables

​
Basic Example

{
  "type": "text",
  "content": "Thanks for signing up!"
}

​
Fields

​
type
string
required
The type of element. For text elements, this value must be "text".
​
content
string
The text content displayed in the notification. Either this field or the elements field must be specified. Supports Handlebars variables for dynamic content.
​
elements
TextContentElement[]
An array of Text Content Elements (string, link, img). Either this field or the content field must be specified. See the Text Content Elements section below.
​
align
string
Text alignment. One of "left", "center", or "right". Defaults to "left".
​
text_style
string
Allows the text to be rendered as a heading level. Can be "text", "h1", "h2", or "subtext". Defaults to "text".
​
color
string
Specifies the color of text. Can be any valid CSS color value (e.g., "#007bff", "rgb(0, 123, 255)").
​
bold
boolean
Apply bold formatting to the text.
​
italic
boolean
Apply italic formatting to the text.
​
strikethrough
boolean
Apply a strikethrough to the text.
​
underline
boolean
Apply an underline to the text.
​
locales
object
Region-specific content for localization. See the Locales documentation for more details.
​
channels
string[]
An array of channel names. The text will only be rendered for the specified channels. See Control Flow documentation for details.

​
Examples & Variants

​
Basic Text

Simple text content: 
{
  "type": "text",
  "content": "Thanks for signing up!"
}

​
Text with Handlebars

Dynamic text with variables: 
{
  "type": "text",
  "content": "This is a notification I sent to {{first_name}}"
}
Variables come from message.data (e.g., data.first_name).

​
Styled Text

Text with formatting: 
{
  "type": "text",
  "content": "Important Notice",
  "text_style": "h2",
  "bold": true,
  "color": "#007bff",
  "align": "center"
}

​
Localized Text

Text with translations: 
{
  "type": "text",
  "content": "This is a notification I sent to {{first_name}}",
  "locales": {
    "es": {
      "content": "Ceci est une notification que j'ai envoyée à {{first_name}}"
    },
    "fr": {
      "content": "Ceci est une notification que j'ai envoyée à {{first_name}}"
    }
  }
}

​
Heading Styles

Use text as headings: 
{
  "type": "text",
  "content": "Welcome to Our Platform",
  "text_style": "h1"
},
{
  "type": "text",
  "content": "Get started in minutes",
  "text_style": "subtext"
}

​
Text Content Elements

The text element can contain an array of text content elements instead of (or in addition to) the content field. These sub-elements allow you to create rich, inline text with links, images, and formatted strings.
Text content elements (string, link, img) must be children of a text element. They cannot be used as standalone top-level elements.

​
String Element

Renders a simple string. Similar to default text behavior but allows for inline formatting within a text element. Fields:
​
type
string
required
The type of element. For string elements, this value must be "string".
​
content
string
required
The text content displayed in the notification.
​
align
string
Text alignment. One of "left", "center", or "right".
​
text_style
string
Allows the text to be rendered as a heading level. Can be "text", "h1", "h2", or "subtext".
​
color
string
Specifies the color of text. Can be any valid CSS color value.
​
bold
boolean
Apply bold formatting to the text.
​
italic
boolean
Apply italic formatting to the text.
​
strikethrough
boolean
Apply a strikethrough to the text.
​
underline
boolean
Apply an underline to the text.
​
locales
object
Region-specific content for localization.
Renders a clickable link within a body of text. Fields:
​
type
string
required
The type of element. For link elements, this value must be "link".
​
content
string
required
The text content of the link (the clickable text).
​
href
string
The address to link to. When provided, the link becomes clickable.
​
disable_tracking
boolean
Disable click tracking for the link. By default, Courier tracks link clicks.
​
align
string
Text alignment. One of "left", "center", or "right".
​
text_style
string
Allows the text to be rendered as a heading level. Can be "text", "h1", "h2", or "subtext".
​
color
string
Specifies the color of text. Can be any valid CSS color value.
​
bold
boolean
Apply bold formatting to the text.
​
italic
boolean
Apply italic formatting to the text.
​
strikethrough
boolean
Apply a strikethrough to the text.
​
underline
boolean
Apply an underline to the text.
​
locales
object
Region-specific content for localization.

​
Img Element

Renders an image inline within a body of text. Fields:
​
type
string
required
The type of element. For inline image elements, this value must be "img".
​
src
string
required
The source address of the image. Must be a publicly accessible URL.
​
alt_text
string
Text used for screen readers and displayed on mouse hover. Important for accessibility.
​
width
string
How wide the image should render. Can be any valid CSS width value (e.g., "50px", "100%").
​
href
string
An address to link to. Makes the image clickable.
​
disable_tracking
boolean
Disable click tracking for the link (if href is provided).
​
align
string
Text alignment. One of "left", "center", or "right".
​
text_style
string
Allows the text to be rendered as a heading level. Can be "text", "h1", "h2", or "subtext".
​
color
string
Specifies the color of text (for any text overlay).
​
bold
boolean
Apply bold formatting (for any text overlay).
​
italic
boolean
Apply italic formatting (for any text overlay).
​
strikethrough
boolean
Apply a strikethrough (for any text overlay).
​
underline
boolean
Apply an underline (for any text overlay).
​
locales
object
Region-specific content for localization. Can localize src and href.

​
Examples with Text Content Elements

​
Text with Inline Links

Combine strings and links: 
{
  "type": "text",
  "elements": [
    { "type": "string", "content": "Hey! " },
    { "type": "link", "content": "Check out this site.", "href": "https://www.example.com" },
    { "type": "string", "content": " It's awesome!" }
  ]
}

​
Text with Inline Images

Include images within text: 
{
  "type": "text",
  "elements": [
    { "type": "string", "content": "Check out this emoji: " },
    { "type": "img", "src": "https://emoji.com/cool-emoji", "width": "20px", "alt_text": "Cool emoji" },
    { "type": "string", "content": " Pretty cool, right?" }
  ]
}

​
Rich Formatted Text

Mix strings, links, and formatting: 
{
  "type": "text",
  "elements": [
    { "type": "string", "content": "Welcome, ", "bold": true },
    { "type": "string", "content": "{{user_name}}", "bold": true, "color": "#007bff" },
    { "type": "string", "content": "! Visit our " },
    { "type": "link", "content": "documentation", "href": "https://docs.example.com", "bold": true },
    { "type": "string", "content": " to get started." }
  ]
}

​
Text with Multiple Links

Multiple links in one text element: 
{
  "type": "text",
  "elements": [
    { "type": "string", "content": "Check out our " },
    { "type": "link", "content": "blog", "href": "https://example.com/blog" },
    { "type": "string", "content": " and " },
    { "type": "link", "content": "documentation", "href": "https://example.com/docs" },
    { "type": "string", "content": " for more information." }
  ]
}

​
Best Practices

  • Use content for simple text: When you just need plain text, use the content field
  • Use elements for rich formatting: Use the elements array when you need inline links, images, or complex formatting
  • Keep text concise: Long paragraphs can be hard to read, especially in email
  • Use headings appropriately: Use text_style to create proper heading hierarchy
  • Test formatting: Different channels may render formatting differently

​
Channel Support

  • Email: ✅ Full support with all formatting options
  • Push: ✅ Supported (formatting may be limited)
  • SMS: ⚠️ Limited support (plain text only)
  • Inbox: ✅ Full support with rich formatting