diff --git a/Notify_boxcar.md b/Notify_boxcar.md index 3db86e5..1757a53 100644 --- a/Notify_boxcar.md +++ b/Notify_boxcar.md @@ -4,48 +4,45 @@ * **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](ttps://boxcar.io/). 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**:://**{hostname}** -* **boxcar**:://**{hostname}**:**{port}** -* **boxcar**:://**{user}**:**{hostname}** -* **boxcar**:://**{user}**@**{password}**:**{hostname}** +* **boxcar**://**{access_key}**/**{secret_key}** Tags support: -* **boxcar**:://**{hostname}**/**@{tag_id}** -* **boxcar**:://**{hostname}**/**@{tag_id01}**/**@{tag_id02}**/**@{tag_idNN}** +* **boxcar**://**{access_key}**/**{secret_key}**/**@{tag_id}** +* **boxcar**://**{access_key}**/**{secret_key}**/**@{tag_id01}**/**@{tag_id02}**/**@{tag_idNN}** + Device Tokens: -* **boxcar**:://**{hostname}**/**{device_id}** -* **boxcar**:://**{hostname}**/**{device_id01}**/**{device_id02}**/**{device_idNN}** +* **boxcar**://**{access_key}**/**{secret_key}**/**{device_id}** +* **boxcar**://**{access_key}**/**{secret_key}**/**{device_id01}**/**{device_id02}**/**{device_idNN}** Alias support: -* **boxcar**:://**{hostname}**/**{alias}** -* **boxcar**:://**{hostname}**/**{alias01}**/**{alias02}**/**{aliasNN}** +* **boxcar**://**{access_key}**/**{secret_key}**/**{alias}** +* **boxcar**://**{access_key}**/**{secret_key}**/**{alias01}**/**{alias02}**/**{aliasNN}** You can also form any combination of the above and perform updates from one url: -* **boxcar**:://**{accesstoken}**/**{tag_id}**/**{device_id}**/**@{alias_id}** - -Secure connections can be made by using **boxcars://**. +* **boxcar**://**{access_key}**/**{secret_key}**/**{tag_id}**/**{device_id}**/**@{alias_id}** ### Parameter Breakdown | Variable | Required | Description | ----------- | -------- | ----------- -| hostname | Yes | The server Boxcar is listening on. -| port | No | The port Boxcar is listening on. By default the port is **80** for **boxcar://** and **443** for all **boxcars://** references. -| user | No | If your boxcar server is protected by a user/pass combo, you will be required to provide it. -| password | No | If your boxcar server is protected by a user/pass combo, you will be required to provide it. +| 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_. | alias | No | Associated aliases with your Boxcar setup. All _alias_ids_ are 1 to 63 characters in length. #### Example -Send a _secure_ Boxcar notification to an alias and a _tag_: +Send a Boxcar notification to all devices associated with a project: ```bash # Assume: -# - our {hostname} is localhost -# - our host is secured (we use boxcars://) -# - our {alias} is myphone -# - our {tag} is @friends +# - our {access_key} is Uabc_543Ehr_t1-1snO-bcgfnak5dnHHHKkbIMi3pJz1KEP5zGo9KwDnIb-7_Kab +# - our {secret_key} is a6k_4ABnck26hDh8AA3EDHoOVdDEUlw3ntyFFkj300012fl9y0b5AW9g9Nsejb8P +Uabc_543Ehr_t1-1snO-bcgfnak5dnHHHKkbIMi3pJz1KEP5zGo9KwDnIb-7_Kab -notify boxcars://localhost/myphone/@friends +notify boxcar://Uabc_543Ehr_t1-1snO-bcgfnak5dnHHHKkbIMi3pJz1KEP5zGo9KwDnIb-7_Kab/a6k_4ABnck26hDh8AA3EDHoOVdDEUlw3ntyFFkj300012fl9y0b5AW9g9Nsejb8P ```