Plex-Meta-Manager/docs/config/notifiarr.md

28 lines
888 B
Markdown
Raw Normal View History

2022-03-08 08:06:22 +00:00
# Notifiarr Attributes
Configuring [Notifiarr](https://notifiarr.com) is optional but can allow you to send the webhooks straight to notifiarr.
A `notifiarr` mapping is in the root of the config file.
Below is a `notifiarr` mapping example and the full set of attributes:
```yaml
notifiarr:
apikey: ####################################
```
2022-07-19 14:54:13 +00:00
| Attribute | Allowed Values | Required |
|:----------|:-----------------------------------------|:--------:|
| `apikey` | Notifiarr API Key | ✅ |
| `develop` | Use the Development Version of Notifiarr | ❌ |
2022-03-08 08:06:22 +00:00
Once you have added the apikey your config.yml you have to add `notifiarr` to any webhook to send that notification to Notifiarr.
```yaml
webhooks:
error: notifiarr
2022-03-18 13:00:42 +00:00
version: notifiarr
2022-03-08 08:06:22 +00:00
run_start: notifiarr
run_end: notifiarr
collection_changes: notifiarr
```