mirror of
https://github.com/caronc/apprise.git
synced 2024-12-04 05:54:35 +01:00
6
Notify_reddit
Chris Caron edited this page 2022-01-29 13:07:48 -05:00
- Source: https://reddit.com
- Icon Support: No
- Message Format: Text
- Message Limit: 6000 Characters per message
Account Setup
- Visit https://old.reddit.com/prefs/apps and scroll to the bottom
- Click on the button that reads 'are you a developer? create an app...'
- Set the mode to
script, - Provide a
name,description, andredirect uri(it can be anything). - Save your configuration:
- Once the bot is saved, you'll be given a ID (next to the the bot name) and a Secret.
- 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