github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity
Page: Notify_reddit
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
6 Notify_reddit
Chris Caron edited this page 2022-01-29 13:07:48 -05:00
Table of Contents

Reddit

  • Source: https://reddit.com
  • Icon Support: No
  • Message Format: Text
  • Message Limit: 6000 Characters per message

Account Setup

  1. Visit https://old.reddit.com/prefs/apps and scroll to the bottom
  2. Click on the button that reads 'are you a developer? create an app...'
  3. Set the mode to script,
  4. Provide a name, description, and redirect uri (it can be anything).
  5. Save your configuration: Reddit-Setup01
  6. Once the bot is saved, you'll be given a ID (next to the the bot name) and a Secret. Reddit-Setup02
  • The App ID will look something like this: YWARPXajkk645m
  • The App Secret will look something like this: YZGKc5YNjq3BsC-bf7oBKalBMeb1xA
  • The App will also have a location where you can identify the users/developers who can also use this key. By default it's already configured to be yours. You will need to use the user/pass of one of the accounts identified here as well to use the posting capabilities.

Syntax

Valid syntax is as follows:

  • reddit://{user}:{pass}@{app_id}/{app_secret}/{subreddit}
  • reddit://{user}:{pass}@{app_id}/{app_secret}/{subreddit_1}/{subreddit_2}/{subreddit_N}

Parameter Breakdown

Variable Required Description
app_id Yes The App ID generated for your script application you created on the Reddit Apps page.
app_secret Yes The App Secret generated for your script application you created on the Reddit Apps page.
user Yes The Reddit UserID associated with one of the developers attached to your application you generated. By default this is just the same user account you used to create the Reddit app in the first place.
pass Yes The Reddit password associated with the UserID defined above.
subreddit Yes The Subreddit you wish to post your message to. You must specify at least 1 of these.
kind No The message kind can be set to either self, link, or auto.
Set this to self to imply you're posting a general/common post to the subreddit. Otherwise, set this to link if the message body you provide (as part of your Apprise payload) only contains a hyperlink/URI to a website. The auto setting (also the default) will parse the message body and set the self/link kind accordingly based on what was detected.
ad No Specify whether or not what you are posting is an advertisement. By default this is set to No.
nsfw No The Not Safe For Work (NSFW) flag. By default this is set to No.
replies No Send all replies of the thread to your (Reddit) inbox? By default this is set to Yes.
resubmit No Let Reddit know this is a re-post. Some subreddits block the re-posting of content; setting this flag to yes can enforce that the content be accepted even if this is the case. Some subreddits will even flag the message differently when you identify it as a re-post up front. This may or may not be what you want. By default this is set to No so that all messages are treated by the upstream server.
spoiler No Mark your post with the spoiler flag. By default this is set to No.
flair_id No Provide the flair_id you want to associate with your post. By default this is not passed upstream unless identified.
flair_text No Provide the flair_text you want to associate with your post. By default this is not passed upstream unless identified.

Note: Reddit always requires a title to go with it's body. Reddit will deny your post (upstream) if you don't provide both.

Example

Send a Reddit Notification

# Assuming our {user} is sstark
# Assuming our {pass} is notAFanOfLannisters
# Assuming our {app_id} is YWARPXajkk645m
# Assuming our {app_secret} is YZGKc5YNjq3BsC-bf7oBKalBMeb1xA
# Assuming we want to post to the {subreddit} Apprise

apprise -vv -t "Test Message Title" -b "Test Message Body" \
   reddit://sstark:notAFanOfLannisters@YWARPXajkk645m/YZGKc5YNjq3BsC-bf7oBKalBMeb1xA/Apprise

Quick Links: