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
  • Frequently Asked Questions
  1. OBJECTS
  2. Topics

Avatar

Each topic gets a default avatar based on its initials, but you can replace it with a custom image to give your topic a unique identity. PNG, JPEG, and GIFs welcome. 😎

Your topic’s avatar is the first thing people see when they subscribe—so make it count. By default, Pushover gives each topic a simple colored circle with the topic title’s initials (think Slack-style). It works… but you can do better.

Want to use your company logo? A mascot? A cat in a spacesuit? Go for it. Custom avatars make your topics more recognizable, more trustworthy, and just a little more fun.

  • Default: Auto-generated with initials and random background color.

  • Custom: Upload any image (PNG, JPG, or GIF) to make it yours.

  • Display: Shown on subscription pages, device notifications, and the Pushover app.

To keep your bandwidth as low as possible we will convert the image to an WebP format. Even your GIF.... we will use the first still.

Use Cases

A good avatar adds instant recognition and a touch of personality. Here’s how people are using them:

Good Use Cases

✅ Branding: Use your company logo so users know the message is official.

✅ Differentiate Topics: Set distinct icons for "🚨 Alerts" vs. "📦 Orders" vs. "💬 Feedback".

✅ Internal Teams: A fun mascot for your DevOps alerts, or your team’s group photo (if you’re brave).

✅ Marketing: Add flair to topics like "🎉 Launch Updates" or "🔥 Hot Deals" to make them stand out.

Bad Use Cases

❌ Using the same avatar for every topic. Confusing.

❌ Uploading a 10MB image. Nobody wants to load a billboard-sized JPEG.

❌ NSFW or meme overload. Unless you're running that kind of operation.

❌ Blank avatars. At least give us some initials, friend.

Requirements

Attribute
Data Type
Validation Criteria

avatar

array

avatar.external_url

string

A valid URL

avatar.body

string

A valid base64 URL

Example Request

curl -X "POST" "https://api.justpush.io/topics" \
     -H 'Content-Type: text/plain; charset=utf-8' \
     -d $'{
  "user": "<< USER KEY>>",
  "avatar": {
     "external_url": "https://picsum.photos/200/300"
   },
}'

Frequently Asked Questions

What image formats are supported for avatars?

You can upload PNG, JPG, or GIF files. JustPush.io will handle the conversion behind the scenes—GIFs are converted to static WebP using the first frame.

Can I use an animated GIF for my avatar?

You can upload one, but animations won't be preserved. We convert GIFs to WebP and use only the first still image as the avatar.

What happens if I don’t upload a custom avatar?

A default avatar will be generated using the topic’s initials and a random background color—clean and simple, but less personal.

Can I update the avatar later?

Absolutely! You can change the avatar at any time to keep your topic fresh, branded, or seasonal. 🎃🎅

PreviousTitleNextAPI reference

Last updated 1 month ago