Browse docs +

Sounds and alert levels

Choose how loud a notification is: which sound plays, whether it rings like a call, and whether it can break through Focus.

Built-in sounds#

Set sound to one of these names. Preview them in the app under Settings → Sounds.

alarm anticipate bell birdsong bloom calypso chime choo descent electronic fanfare glass gotosleep healthnotification horn ladder mailsent minuet multiwayinvitation newmail newsflash noir paymentsuccess shake sherwoodforest silence spell suspense telegraph tiptoes typewriters update

text
https://push.breezelabs.dev/YOUR_KEY/Coffee%20is%20ready?sound=minuet

Custom sounds#

On iPhone, open Settings → Sounds → Add a sound file and pick any m4a, mp3, wav, or caf file. Breeze converts it to the format iOS needs and trims it to 30 seconds. Send its name, as shown in the list, in sound.

To play a sound you host yourself without importing it, send an HTTPS link to a .caf file of up to 6 MB in soundUrl.

Ring like a call#

call=1 repeats the sound for 30 seconds, so a single notification is hard to miss. It works with any built-in or custom sound.

text
https://push.breezelabs.dev/YOUR_KEY/Server%20is%20down?call=1&sound=alarm

Alert levels#

level Behavior
active Default. Sound and banner
passive Added to Notification Center quietly, without lighting the screen
timeSensitive Can break through Focus and stay on the Lock Screen longer, if you allow Time Sensitive notifications for Breeze
critical Plays even in silent mode and Focus. Not available yet

Critical alerts#

Critical alerts need a special entitlement from Apple that Breeze doesn't have yet. Until it is granted, the service answers critical with HTTP 422. Once available, you will turn them on in the app and set the volume with volume, from 0 to 1. Until then, use timeSensitive together with call=1.

On Android#

Android plays the sound set for the Breeze notification channel, so only sound=default is accepted. Change the sound per level in Android's notification settings for Breeze. passive and timeSensitive map to their own channels.