extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00
Code Issues Packages Projects Releases Wiki Activity
Page: Notify_join
Pages
CLI_Usage DemoPlugin_Basic DemoPlugin_WebRequest Development_API Development_Apprise_Details Development_Contribution Development_LogCapture Home Notification_Graveyard Notify_Custom_Form Notify_Custom_JSON Notify_Custom_XML Notify_Revolt Notify_africas_talking Notify_apprise_api Notify_aprs Notify_bark Notify_boxcar Notify_bulksms Notify_bulkvs Notify_burst_sms Notify_chantify Notify_clicksend Notify_d7networks Notify_dapnet Notify_dbus Notify_dingtalk Notify_discord Notify_email Fastmail Notify_email Notify_emby Notify_enigma2 Notify_faast Notify_fcm Notify_feishu Notify_flock Notify_freemobile Notify_gitter Notify_gnome Notify_googlechat Notify_gotify Notify_growl Notify_guilded Notify_homeassistant Notify_httpsms Notify_ifttt Notify_join Notify_kavenegar Notify_kodi Notify_kumulos Notify_lametric Notify_line Notify_lunasea Notify_macosx Notify_mailgun Notify_mastodon Notify_matrix Notify_mattermost Notify_messagebird Notify_misskey Notify_mqtt Notify_msg91 Notify_msteams Notify_nexmo Notify_nextcloud Notify_nextcloudtalk Notify_notica Notify_notifiarr Notify_notifico Notify_ntfy Notify_office365 Notify_onesignal Notify_opsgenie Notify_pagerduty Notify_pagertree Notify_parseplatform Notify_plivo Notify_popcornnotify Notify_prowl Notify_pushalot Notify_pushbullet Notify_pushdeer Notify_pushed Notify_pushjet Notify_pushme Notify_pushover Notify_pushsafer Notify_pushy Notify_reddit Notify_rocketchat Notify_rsyslog Notify_ryver Notify_sendgrid Notify_serverchan Notify_ses Notify_seven Notify_sfr Notify_signal Notify_simplepush Notify_sinch Notify_slack Notify_sms_manager Notify_smseagle Notify_smtp2go Notify_sns Notify_sparkpost Notify_splunk Notify_spontit Notify_streamlabs Notify_stride Notify_synology_chat Notify_syslog Notify_techulus Notify_telegram Notify_threema Notify_toasty Notify_twilio Notify_twist Notify_twitter Notify_voipms Notify_wecombot Notify_whatsapp Notify_windows Notify_workflows Notify_wxpusher Notify_wxteams Notify_xbmc Notify_xmpp Notify_zulip Sponsors Troubleshooting URLBasics config config_text config_yaml decorator_notify persistent_storage showcase
7 Notify_join
Chris Caron edited this page 2020-08-03 10:09:00 -04:00
Table of Contents

Join Notifications

To use this plugin:

  1. Ensure your browser allows popups and visit joinjoaomgcd.appspot.com.
  2. To register you just need to allow the page to link with your Google Profile. The good news is it doesn't ask for anything too personal.
  3. Download the app for your phone from the Android Store here.
  4. Using your phone, when you first open the application, it will ask for a series of permissions and ask you a couple questions.
  5. If you just recently registered your device (in the previous step), you should now be able to refresh your browser at joinjoaomgcd.appspot.com. Your device should list itself. From here you can retrieve the API you need to worth with Apprise.

Syntax

Valid syntax is as follows:

  • join://{apikey}/
  • join://{apikey}/{device_id}
  • join://{apikey}/{device_id1}/{device_id2}/{device_idN}

Note: If no device is specified, then by default group.all is used.

Groups can be referenced like this (the group. part is optional):

  • join://{apikey}/group.{group_id}
  • join://{apikey}/group.{group_id1}/group.{group_id2}/group.{group_idN}
  • join://{apikey}/{group_id}
  • join://{apikey}/{group_id1}/{group_id2}/{group_idN}

If what you specify isn't a group or device_id then it is interpreted as a device_name as a fallback:

  • join://{apikey}/{device_name}
  • join://{apikey}/{device_name1}/{device_name1}/{device_nameN}

You can freely mix and match these combinations as well:

  • join://{apikey}/{device_id}/{group_id}/{device_name}

Parameter Breakdown

Variable Required Description
apikey Yes The api key associated with your Join account.
device_id No The device identifier to send your notification to (a 32 bit alpha-numeri string).
device_name No The device name (PC, Nexus, etc)
group_id No The group identifier to send your notification to.

Example

Send a Join notification to all of our configured devices:

# Assuming our {apikey} is abcdefghijklmnop-abcdefg
# Assume we're sending to the group: all
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   join://abcdefghijklmnop-abcdefg/group.all

Quick Links: