mirror of https://github.com/caronc/apprise
Updated Notify_notifiarr (markdown)
parent
05eac221cc
commit
f0c4795493
|
@ -6,7 +6,7 @@
|
||||||
* **Message Limit**: 32768 Characters per message
|
* **Message Limit**: 32768 Characters per message
|
||||||
|
|
||||||
### Account Setup
|
### Account Setup
|
||||||
You need to first set up an account with [Notifiarr](https://notifiarr.com) if you don't have one already. From there you can generate yourself your `{api_key}`.
|
You need to first set up an account with [Notifiarr](https://notifiarr.com) if you don't have one already. From there you can generate yourself your `{api_key}`. You will need to use your “global” API key, the integration-specific Notifiarr API keys do not work with Apprise.
|
||||||
|
|
||||||
### Discord Channel IDs
|
### Discord Channel IDs
|
||||||
To use Notifiarr, you need your Discord ChannelID. **It must be the numeric version of it**. [Here is some great instructions on how to get it](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
|
To use Notifiarr, you need your Discord ChannelID. **It must be the numeric version of it**. [Here is some great instructions on how to get it](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
|
||||||
|
@ -15,40 +15,38 @@ In short:
|
||||||
- **Enable Developer Mode** by visiting your _Discord Settings_ and going to **Appearance**.
|
- **Enable Developer Mode** by visiting your _Discord Settings_ and going to **Appearance**.
|
||||||
-
|
-
|
||||||
|
|
||||||
|
|
||||||
### Syntax
|
### Syntax
|
||||||
Valid syntax is as follows:
|
Valid syntax is as follows:
|
||||||
- `notifiarr://{api_key}/{channel}`
|
- `notifiarr://{api_key}/{channel_id}`
|
||||||
- `notifiarr://{api_key}/{channel1}/{channel2}/{channelN}`
|
- `notifiarr://{api_key}/{channel1_id}/{channel2_id}/{channelN_id}`
|
||||||
|
|
||||||
|
|
||||||
### Parameter Breakdown
|
### Parameter Breakdown
|
||||||
| Variable | Required | Description |
|
| Variable | Required | Description |
|
||||||
|----------|----------|-------------|
|
| ------------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| api_key | Yes| Your Notifiarr API Key |
|
| api_key | Yes | Your global (not integration-specific) Notifiarr API Key |
|
||||||
| source | No| Optionally provide the source of the notification as a descriptive string (you can also use `from` as an alias to this same variable) |
|
| source | No | Optionally provide the source of the notification as a descriptive string (you can also use `from` as an alias to this same variable) |
|
||||||
| event | No| Optionally specify the Notifiarr Event ID you want your notification update. If none is specified, then a new notification is generated |
|
| event | No | Optionally specify the Notifiarr Event ID you want your notification update. If none is specified, then a new notification is generated |
|
||||||
| discord_user| No| Optionally specify the Discord User ID you wish to Ping via Notifiarr |
|
| discord_user | No | Optionally specify the Discord User ID you wish to Ping via Notifiarr |
|
||||||
| discord_role | No| Optionally specify the Discord Role ID you wish to Ping via Notifiarr |
|
| discord_role | No | Optionally specify the Discord Role ID you wish to Ping via Notifiarr |
|
||||||
|
|
||||||
#### Example
|
#### Example
|
||||||
Send a discord notification:
|
Send a discord notification:
|
||||||
```bash
|
```bash
|
||||||
# Assuming our {APIKey} is 4174216298
|
# Assuming our {APIKey} is 4174216298
|
||||||
# Assuming our {Channel} is General
|
# Assuming our {ChannelID} is 123456789
|
||||||
# Test out the changes with the following command:
|
# Test out the changes with the following command:
|
||||||
apprise -t "Test Title" -b "Test Message" \
|
apprise -t "Test Title" -b "Test Message" \
|
||||||
"notifiarr://4174216298/General"
|
"notifiarr://4174216298/123456789"
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
If you have a Discord Event ID you wish to reference, you can do the following:
|
If you have a Discord Event ID you wish to reference, you can do the following:
|
||||||
```bash
|
```bash
|
||||||
# Assuming our {APIKey} is 4174216298
|
# Assuming our {APIKey} is 4174216298
|
||||||
# Assuming our {Channel} is General
|
# Assuming our {ChannelID} is 123456789
|
||||||
# Assuming our {EventID} is 1234
|
# Assuming our {EventID} is 1234
|
||||||
# Test out the changes with the following command:
|
# Test out the changes with the following command:
|
||||||
apprise -t "Test Title" -b "Test Message" \
|
apprise -t "Test Title" -b "Test Message" \
|
||||||
"notifiarr://4174216298/General?event=1234"
|
"notifiarr://4174216298/123456789?event=1234"
|
||||||
|
|
||||||
```
|
```
|
Loading…
Reference in New Issue