diff --git a/Notify_ryver.md b/Notify_ryver.md new file mode 100644 index 0000000..13ad9ac --- /dev/null +++ b/Notify_ryver.md @@ -0,0 +1,46 @@ +## Ryver Notifications +* **Source**: https://ryver.com/ +* **Icon Support**: Yes +* **Message Format**: TEXT +* **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}``` + +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``` and the organization is **apprise**. + +### Syntax +Valid syntaxes are as follows: +* **ryver**://**{organization}**/**{token}**/ +* **ryver**://**{user}**@**{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* +| user | 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: +```bash +# Assuming our {organization} is apprise +# Assuming our {token} is T1JJ3T3L2 +apprise ryver:///apprise/T1JJ3T3L2 +```