Browse docs +

Parameters

Use these names in the query string, form data, or JSON. Names are case-insensitive, and values can be strings or numbers. Breeze uses Bark's parameter names, so most Bark scripts work unchanged. “All” in the Platform column means iPhone and Android.

Content#

Parameter Description Platform
title Title All
subtitle Subtitle All
body Body text. message also works All
markdown Body in Markdown. The banner shows plain text; History shows the formatted version. Use instead of body All
group Groups notifications in Notification Center and History. thread_id also works All
url HTTPS link opened when you tap the notification All
image HTTPS image shown in the notification and History All
icon HTTPS image shown as the sender avatar All
copy Text copied by the notification's Copy action. Defaults to the body All
autoCopy 1 copies copy (or the body) to the clipboard when the notification arrives iOS
badge Number on the app icon. 0 clears it iOS

Sound and alert level#

Parameter Description Platform
sound A built-in or custom sound name, or default. Android plays default only. See Sounds and alert levels All
call 1 repeats the sound for 30 seconds, like an incoming call iOS
soundUrl HTTPS link to a .caf sound, up to 6 MB, played for this notification iOS
level active (default), passive (no sound or banner), timeSensitive (breaks through Focus when allowed), or critical (not available yet) All
volume Volume for critical alerts, from 0 to 1, once they are available iOS

Message management#

Parameter Description Platform
id Your own message ID. A new notification with the same id replaces the earlier one All
delete 1 with an id withdraws that notification from the device All
ttl Seconds to keep the message in History. 0 doesn't save it All
isArchive 0 doesn't save this message in History; 1 saves it even when saving is off iOS
collapse_id Coalesces pending notifications with the same value. Up to 64 bytes All

Update and withdraw messages explains how these work together.

Encryption and filters#

Parameter Description Platform
ciphertext Encrypted parameters. See Encryption iOS
iv IV for ciphertext, if it differs from the one saved in the app iOS
filter_criteria Name used by Breeze's Focus filter, for example work iOS

Friendly names#

Breeze also accepts these longer names. If you send both forms, the Bark name wins.

Name Same as
message body
thread_id group
open_url url
image_url / icon_url image / icon
sound_url soundUrl
interruption_level level; time-sensitive also works

Android rejects parameters it can't honor with HTTP 422 instead of ignoring them. The API reference lists advanced fields such as expiration_date, priority, data, and raw Apple payloads.