apprise

Table of Contents

Boxcar Notifications

Syntax
Parameter Breakdown

Example

Boxcar Notifications

Source: https://boxcar.io/
Icon Support: No
Message Format: Text
Message Limit: 10000 Characters per Message

Boxcar just has a development platform these days. You can't get notifications through your AppleOS or Android devices anymore. You can still however sign up for an account on their website. From there you can create projects through them.

Each project you create with them will grant you access to your own unique Access Key and a Secret Key. You can post notifications knowing these 2 values.

Syntax

Valid authentication syntaxes are as follows:

boxcar://{access_key}/{secret_key}

Tags support:

boxcar://{access_key}/{secret_key}/@{tag_id}
boxcar://{access_key}/{secret_key}/@{tag_id01}/@{tag_id02}/@{tag_idNN}

Device Tokens:

boxcar://{access_key}/{secret_key}/{device_id}
boxcar://{access_key}/{secret_key}/{device_id01}/{device_id02}/{device_idNN}

You can also form any combination of the above and perform updates from one url:

boxcar://{access_key}/{secret_key}/@{tag_id}**/{device_id}

Parameter Breakdown

Variable	Required	Description
access_key	Yes	This is required for your account to work. You will be provided one from boxcar's website upon creating an account with them.
secure_key	Yes	This is required for your account to work. You will be provided one from boxcar's website upon creating an account with them.
device_id	No	Associated devices with your Boxcar setup. All device_ids are 64 characters in length.
tag_id	No	Tags must be prefixed with a @ symbol or they will be interpreted as a device_id and/or alias.

Example

Send a Boxcar notification to all devices associated with a project:

# Assume:
#  - our {access_key} is pJz1KEP5zGo9KwDnIb-7_Kab
#  - our {secret_key} is j300012fl9y0b5AW9g9Nsejb8P
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   boxcar://pJz1KEP5zGo9KwDnIb-7_Kab/j300012fl9y0b5AW9g9Nsejb8P

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface