JustPush.io
  • Introduction
  • New? Start Here
  • The Glossary
  • USER MANUAL
    • Getting Started
    • API Key
    • JustPush Email
  • OBJECTS
    • Messages
      • Title
      • Topic
      • Message
      • Priority
      • Sounds
      • Images
      • Acknowledgements
      • Buttons
      • Button Groups
      • Expiry TTL
    • Topics
      • Title
      • Avatar
  • DEV TOOLS
    • API reference
      • Messages
      • Topics
    • OpenAPI
    • Rapid API
    • Postman
    • SDKs
    • Changelog
Powered by GitBook
On this page
  • Use cases
  • Requirements
  • Example Request
  • Mobile App
  • Frequently Asked Questions
  1. OBJECTS
  2. Messages

Images

We support 1 to 10 images to make your notifications more visual. Each image can have a caption and be provided via URL or base64 encoding. Perfect for charts, memes or security camera snapshots.


Why settle for plain text when you can show what’s happening? Whether it’s a screenshot of an error log, a security camera feed, or a celebratory GIF, images add context and impact to your notifications.

  • Quantity: You can attach 1 to 10 images per message.

  • Source: Images can be provided as a direct URL or base64-encoded data.

  • Captions: Each image can have an optional caption for extra context (e.g., "Front Door Camera Snapshot").

Use cases

Images make your notifications more useful (or just more fun). Here are some ways you can use them effectively:

Good Use Cases

✅ Home Automation: “Front door opened” with a security camera snapshot. ✅ Monitoring & Alerts: A graph of CPU usage skyrocketing before disaster strikes. ✅ Fun & Memes: “Deployment successful” with a GIF of fireworks.

Bad Use Cases

❌ Spamming 10 images of your cat. (Okay, maybe once.) ❌ Huge base64-encoded files. (Our server will start hating you.)

Requirements

Attribute
Data Type
Validation Criteria

images

array

max 10 items

images.*.caption

string

max 255 characters

images.*.url

url

a valid url the image can be downloaded from

images.*.body

string

a valid base64 encoded image

Either the body or the url is required within an image.

Example Request

curl -X "POST" "https://api.justpush.io/messages" \
     -H 'Content-Type: application/json' \
     -d $'{
  "user": "<< USER KEY >>",
  "title": "A simple title",
  "message": "A simple test message",
  "images": [
    {
      "url": "https://picsum.photos/800/600"
      "caption": "Thanks Picsum"
    }
  ],
}'

Mobile App

Below you see an example of how this displayed as a push message and within the app.

Push Message

JustPush.io App

Once the image is clicked / touched, it will open an gallery mode.


Frequently Asked Questions

Is there a file size limit?

Yup, we don't accept images larger than 5.0MB. Images larger won't be processed

Can I mix URLs and base64 images?

Absolutely! Some images can be URLs, while others can be base64-encoded in the same message.

{
  "images": 
  [
    {
      "caption": "Random Image",
      "url": "https://picsum.photos/800/600"
    },
    {
      "caption": "Random Base64 Image",
      "body": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mP8/wcAAwAB/ed4a1sAAAAASUVORK5CYII="
    }
  ]
}

What happens if an image fails to load?

If a URL is broken or base64 data is corrupted, the image just won’t appear—no error messages, no drama.

Can I send GIFs?

Yes! Animated GIFs work, but they won’t be animated inside the notification.

PreviousSoundsNextAcknowledgements

Last updated 1 month ago

Push Message with an image
Message with an image