OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

Images & Rich Media

Adding additional media to notifications.

Images

Large Images for Mobile Push Notifications can be added on iOS and Android. For Web Push, see Web Push Features.

Mobile Push large images will display in the "expanded view" of the notification, generally when you long-press or swipe to view.

Images can be added to push using the Dashboard or API Image Parameters.

Recommended Image Details

The recommended image is a jpg filetype with 2:1 aspect ratio landscape, size 512x256px or 1440x720px.

iOS

Android

Filetypes

Recommended: jpg

jpeg, png, gif

Recommended:jpg

jpeg, png, gif*

Resolution

Recommended: 2:1 aspect ratio landscape

Common sizes:
512x256px
1440x720px

Max Width: 4096 pixels
Min Width: 300 pixels

Recommended: 2:1 aspect ratio landscape

Common sizes:
512x256px
1440x720px

Max Width: 2000 pixels
Min Width: 300 pixels

OneSignal API Parameter

ios_attachments

big_picture

  • gif image animations not supported on Android mobile apps.
  • Adding Action Buttons may affect image sizes, please try testing on your devices to make sure the layout fits your needs.
  • Android 4.1+ and iOS 10+ supports large images.
  • For troubleshooting, see Notification Images Not Showing.

Rich Notifications

iOS 10+

Apple introduced the concept of Rich Notifications in iOS 10, which allow deeper interaction with your app from the notification itself. These are great for short interactions that do not require the full app experience, and represent the growing importance of notifications to an app's user experience.

Rich notifications side-step the process of tapping a notification, unlocking the phone, waiting for the app to load, and then interacting with the app, by creating opportunities for short interactions within the notification itself.

OneSignal fully supports iOS 10 rich notifications. You can read more about Rich Notifications in our blog post on iOS Customizations.

At a technical level, there are two types of rich notifications: content extensions and media attachments.

Content Extensions

Content extensions allow developers to add custom views of their app within a notification. For instance, this notification lets the user view the relevant details of their calendar when responding to a meeting invite.

See iOS Image Carousel Push Notifications for example.

Media Attachments

Media attachments allow developers to attach URLs to relevant content. This is great for live events, photo tagging, and game updates, as well as all sorts of other visual content. Pictures speak a thousand words, and video more so, and with media attachments its never been easier to transport users into another place at the touch of a button. In the following example, a travel app could prompt users with visuals of a wonderful destination:

Support media formats

Media formats supported by iOS 10+.

Make sure the hosted image, video or audio is a direct link to the resource. If it does not end in a correct file extension (listed File Type's below), you can add for example &file=type.mp4 (use your resource's correct .file_extension) to the end of the url so our SDK recognizes this as a media url.

🚧

Media Uploads

OneSignal does not support uploading video media. You would need to host the video on your own servers and include the URL to the resource within the ios_attachments / Media properties.

Attachment

File Type

Max Size

Audio

aif / aiff

5MB

Audio

wav

5MB

Audio

MP3

5MB

Audio/Video

MP4

5MB

Image

JPEG

10MB

Image

GIF

10MB

Image

PNG

10MB

Video

MPEG

50MB

Video

MPEG2

50MB

Video

MPEG4

50MB

Video

AVI

50MB

Mobile Push Image Troubleshooting

See Notification Images Not Showing Troubleshooting guide.

Updated 25 days ago


Images & Rich Media


Adding additional media to notifications.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.