2022-03-08 08:06:22 +00:00
|
|
|
# Notifiarr Attributes
|
|
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
Configuring [Notifiarr](https://notifiarr.com) is optional but can allow you to send the [webhooks](webhooks.md)
|
|
|
|
|
straight to notifiarr.
|
2022-03-08 08:06:22 +00:00
|
|
|
|
|
|
|
|
A `notifiarr` mapping is in the root of the config file.
|
|
|
|
|
|
|
|
|
|
Below is a `notifiarr` mapping example and the full set of attributes:
|
2022-10-26 18:01:39 +00:00
|
|
|
|
2022-03-08 08:06:22 +00:00
|
|
|
```yaml
|
|
|
|
|
notifiarr:
|
|
|
|
|
apikey: ####################################
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-13 21:44:44 +00:00
|
|
|
| Attribute | Allowed Values | Required |
|
|
|
|
|
|:----------|:-----------------------------------------|:------------------------------------------:|
|
|
|
|
|
| `apikey` | Notifiarr API Key | :fontawesome-solid-circle-check:{ .green } |
|
2022-03-08 08:06:22 +00:00
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
Once you have added the apikey your config.yml you have to add `notifiarr` to any [webhook](webhooks.md) to send that
|
|
|
|
|
notification to Notifiarr.
|
2022-03-08 08:06:22 +00:00
|
|
|
|
|
|
|
|
```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
|
2022-10-26 18:01:39 +00:00
|
|
|
changes: notifiarr
|
2022-03-08 08:06:22 +00:00
|
|
|
```
|
