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_ryver
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_ryver
Chris Caron edited this page 2020-08-03 09:58:32 -04:00
Table of Contents

Ryver Notifications

  • Source: https://ryver.com/
  • Icon Support: Yes
  • Message Format: Markdown
  • Message Limit: 1000 Characters per message

Account Setup

To use Ryver you'll need to have the forum(s) you intend to notify already pre-created. You'll need to do this before you follow the next set of instructions.

Next you need to define a new webhook and get the corresponding URL. This is done through:

  1. click on the Integrations > Incoming Webhooks beneath your settings on the left
  2. click on the Create Webhook button
  3. choose either Slack or Plain/text Ryver as this plugin currently supports both.
  4. Regardless of what webhook type you choose to create (Slack or Ryver), the next steps are still the same:
    • Set the webhook type to Chat Message
    • Select the forum(s) you already have set up to allow this webhook to access.
    • Click next.

When you've completed this process you will receive a URL that looks something like this: https://apprise.ryver.com/application/webhook/ckhrjW8w672m6HG

This effectively equates to:
https://{organization}.ryver.com/application/webhook/{token}

Note: Apprise supports this URL as-is (as of v0.7.7); you no longer need to parse the URL any further. However there is slightly less overhead (internally) if you do.

The last part of the URL you're given is the token we're most interested in. With respect to the above example:

  • the token is ckhrjW8w672m6HG
  • the organization is apprise

Syntax

Valid syntaxes are as follows:

  • https://{organization}.ryver.com/application/webhook/{token}
  • ryver://{organization}/{token}/
  • ryver://{botname}@{organization}/{token}/
  • ryver://{organization}/{token}/?webhook=slack

Parameter Breakdown

Variable Required Description
organization Yes The organization you created your webhook under.
token Yes The token provided to you after creating a incoming-webhook
botname No Set the display name the message should appear from.
webhook No The type of webhook you created (Slack or Ryver). The only possible values are slack and ryver. The default value is ryver if the webhook value isn't specified.

Example

Send a ryver notification:

# Assuming our {organization} is apprise
# Assuming our {token} is T1JJ3T3L2
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   ryver:///apprise/T1JJ3T3L2

Quick Links: