Skip to main content
The image element embeds an image in your notification. Images can be aligned, sized, linked, and given alt text. The type value is "image". When to use:
  • Display logos, product images, or illustrations
  • Add visual elements to enhance notifications
  • Create clickable image banners
  • Include user avatars or profile pictures
Basic example
Fields
string
required
The image URL. Must be publicly accessible.
string
Alternate text for the image. Screen readers use it, and it displays when the image cannot load.
string
A URL to open when the image is clicked.
string
CSS width for the image. Can be:
  • Fixed: "200px", "300px"
  • Percentage: "50%", "100%"
  • Auto: "auto"
string
The alignment of the image. One of "center", "left", "right", or "full". Defaults to "center".
string
CSS border color applied to the image (e.g., "#ccc").
string
CSS border width applied to the image (e.g., "1px").
string
CSS padding applied around the image (e.g., "10px").
object
Region-specific content for localization. Can localize src (image URL) and href (link URL). See the .
string[]
An array of channel names. The image renders only for the listed channels. See .
Examples and variants Basic image Simple image with alt text:
Clickable image Image that links to a URL:
Sized and aligned image Control image size and alignment:
Localized image Use different images for different locales:
Channel-specific image Show different images per channel:
Full-width banner Full-width banner image:
Channel support
  • Email: ✅ Full support with alignment, sizing, and linking
  • Push: ✅ Supported (typically as notification icon or banner)
  • SMS: ❌ Not supported (text-only channel)
  • Inbox: ✅ Full support