"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
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 can’t 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
Translations of
src (image URL) and href (link URL), keyed by locale code. alt_text stays in the default language. See .string[]
An array of channel names. The image renders only for the listed channels. See .
- 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