Skip to content

Commit c2d9183

Browse files
committed
docs: Add Threema Gateway alert provider
1 parent 232a4b9 commit c2d9183

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ Have any feedback or questions? [Create a discussion](https://github.com/TwiN/ga
9191
- [Configuring Teams alerts *(Deprecated)*](#configuring-teams-alerts-deprecated)
9292
- [Configuring Teams Workflow alerts](#configuring-teams-workflow-alerts)
9393
- [Configuring Telegram alerts](#configuring-telegram-alerts)
94+
- [Configuring Threema Gateway alerts](#configuring-threema-gateway-alerts)
9495
- [Configuring Twilio alerts](#configuring-twilio-alerts)
9596
- [Configuring Vonage alerts](#configuring-vonage-alerts)
9697
- [Configuring Webex alerts](#configuring-webex-alerts)
@@ -861,6 +862,7 @@ endpoints:
861862
| `alerting.teams` | Configuration for alerts of type `teams`. *(Deprecated)* <br />See [Configuring Teams alerts](#configuring-teams-alerts-deprecated). | `{}` |
862863
| `alerting.teams-workflows` | Configuration for alerts of type `teams-workflows`. <br />See [Configuring Teams Workflow alerts](#configuring-teams-workflow-alerts). | `{}` |
863864
| `alerting.telegram` | Configuration for alerts of type `telegram`. <br />See [Configuring Telegram alerts](#configuring-telegram-alerts). | `{}` |
865+
| `alerting.threema-gateway` | Configuration for alerts of type `threema-gateway`. <br />See [Configuring Threema Gateway alerts](#configuring-threema-gateway-alerts).| `{}` |
864866
| `alerting.twilio` | Settings for alerts of type `twilio`. <br />See [Configuring Twilio alerts](#configuring-twilio-alerts). | `{}` |
865867
| `alerting.vonage` | Configuration for alerts of type `vonage`. <br />See [Configuring Vonage alerts](#configuring-vonage-alerts). | `{}` |
866868
| `alerting.webex` | Configuration for alerts of type `webex`. <br />See [Configuring Webex alerts](#configuring-webex-alerts). | `{}` |
@@ -2241,6 +2243,23 @@ Here's an example of what the notifications look like:
22412243
![Telegram notifications](.github/assets/telegram-alerts.png)
22422244

22432245

2246+
#### Configuring Threema Gateway alerts
2247+
| Parameter | Description | Default |
2248+
|:---------------------------------------------|:------------------------------------------------------------------------------------------------------------|:----------------------------|
2249+
| `alerting.threema-gateway` | Configuration for alerts of type `threema-gateway` | `{}` |
2250+
| `alerting.threema-gateway.api-url` | Threema Gateway API URL | `https://msgapi.threema.ch` |
2251+
| `alerting.threema-gateway.mode` | Mode used to send the alert, currently only `basic` is supported | `"basic"` |
2252+
| `alerting.threema-gateway.api-identity` | Personal Threema API Identity | Required `""` |
2253+
| `alerting.threema-gateway.recipients` | Recipients in format `[<type>:]<identifier>`, where type is `id`, `phone` or `email`. Type defaults to `id` | Required `""` |
2254+
| `alerting.threema-gateway.auth-secret` | Threema Gateway API authentication secret | Required `""` |
2255+
| `alerting.threema-gateway.default-alert` | Default alert configuration. <br />See [Setting a default alert](#setting-a-default-alert) | N/A |
2256+
| `alerting.threema-gateway.overrides` | List of overrides that may be prioritized over the default configuration | `[]` |
2257+
| `alerting.threema-gateway.overrides[].group` | Endpoint group for which the configuration will be overridden by this configuration | `""` |
2258+
| `alerting.threema-gateway.overrides[].*` | See `alerting.threema-gateway.*` parameters | `{}` |
2259+
2260+
[comment]: TODO#1464 Add yaml config example
2261+
2262+
22442263
#### Configuring Twilio alerts
22452264
| Parameter | Description | Default |
22462265
|:--------------------------------|:-------------------------------------------------------------------------------------------|:--------------|

0 commit comments

Comments
 (0)