Debian Codegraph @

docs/services/overview.md

raw
1 # Services Overview
2
3 ## Chat Services
4
5 Click on the service for a more thorough explanation.
6
7 | Service | URL format |
8 |-------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------|
9 | [Discord](./chat/discord/index.md) | *discord://__`token`__@__`id`__[?thread_id=__`threadid`__]* |
10 | [Google Chat](./chat/googlechat/index.md) | *googlechat://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz* |
11 | [Hangouts](./chat/hangouts/index.md)* | *hangouts://chat.googleapis.com/v1/spaces/FOO/messages?key=bar&token=baz* |
12 | [Lark](./chat/lark/index.md) | *lark://__`host`__/__`token`__?secret=__`secret`__&title=__`title`__&link=__`url`__* |
13 | [Matrix](./chat/matrix/index.md) | *matrix://__`username`__:__`password`__@__`host`__:__`port`__/[?rooms=__`!roomID1`__[,__`roomAlias2`__]]* |
14 | [Mattermost](./chat/mattermost/index.md) | *mattermost://[__`username`__@]__`mattermost-host`__/__`token`__[/__`channel`__]* |
15 | [Rocketchat](./chat/rocketchat/index.md) | *rocketchat://[__`username`__@]__`rocketchat-host`__/__`token`__[/__`channel`|`@recipient`__]* |
16 | [Signal](./chat/signal/index.md) | *signal://[__`user`__[:__`password`__]@]__`host`__[:__`port`__]/__`source_phone`__/__`recipient1`__[,__`recipient2`__,...]* |
17 | [Slack](./chat/slack/index.md) | *slack://[__`botname`__@]__`token-a`__/__`token-b`__/__`token-c`__* |
18 | [Teams](./chat/teams/index.md) | *teams://?host=__`Power Automate workflow URL`__* |
19 | [Telegram](./chat/telegram/index.md) | *telegram://__`token`__@telegram?chats=__`@channel-1`__[,__`chat-id-1`__,...]* |
20 | [WeCom](./chat/wecom/index.md) | *wecom://__`key`__* |
21 | [Zulip Chat](./chat/zulip/index.md) | *zulip://__`bot-mail`__:__`bot-key`__@__`zulip-domain`__/?stream=__`name-or-id`__&topic=__`name`__* |
22
23 \* Deprecated
24
25 ## Push Services
26
27 | Service | URL format |
28 |------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|
29 | [Bark](./push/bark/index.md) | *bark://__`devicekey`__@__`host`__* |
30 | [Gotify](./push/gotify/index.md) | *gotify://__`gotify-host`__/__`token`__* |
31 | [IFTTT](./push/ifttt/index.md) | *ifttt://__`key`__/?events=__`event1`__[,__`event2`__,...]&value1=__`value1`__&value2=__`value2`__&value3=__`value3`__* |
32 | [Join](./push/join/index.md) | *join://shoutrrr:__`api-key`__@join/?devices=__`device1`__[,__`device2`__, ...][&icon=__`icon`__][&title=__`title`__]* |
33 | [MQTT](./push/mqtt/index.md) | *mqtt://[__`username`__[:__`password`__]@]__`host`__[:__`port`__]/__`topic`__* |
34 | [Ntfy](./push/ntfy/index.md) | *ntfy://__`username`__:__`password`<[email protected]>/__`topic`__* |
35 | [Pushbullet](./push/pushbullet/index.md) | *pushbullet://__`api-token`__[/__`device`__/#__`channel`__/__`email`__]* |
36 | [Pushover](./push/pushover/index.md) | *pushover://shoutrrr:__`apiToken`__@__`userKey`__/?devices=__`device1`__[,__`device2`__, ...]* |
37
38 ## Incident Services
39
40 | Service | URL format |
41 |--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
42 | [OpsGenie](./incident/opsgenie/index.md) | *opsgenie://__`host`__/token?responders=__`responder1`__[,__`responder2`__]* |
43 | [PagerDuty](./incident/pagerduty/index.md) | *pagerduty://[host[:port]]/__`integration-key`__[?query-parameters]* |
44
45 ## Email Services
46
47 | Service | URL format |
48 |--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
49 | [Email](./email/smtp/index.md) | *smtp://__`username`__:__`password`__@__`host`__:__`port`__/?fromaddress=__`fromAddress`__&toaddresses=__`recipient1`__[,__`recipient2`__,...][&additional_params]* |
50
51 ## SMS Services
52
53 | Service | URL format |
54 |--------------------------------------|------------------------------------------------------------------------------------------------------------|
55 | [Twilio](./sms/twilio/index.md) | *twilio://__`accountSID`__:__`authToken`__@__`fromNumber`__/__`toNumber`__* |
56
57 ## Specialized Services
58
59 | Service | Description |
60 |---------------------------------------------------|--------------------------------------------------------------|
61 | [Generic Webhook](./specialized/generic/index.md) | Sends notifications directly to a webhook |
62 | [Logger](./specialized/logger/index.md) | Writes a notification to a configured Go `log.Logger` |
63 | [Notifiarr](./specialized/notifiarr/index.md) | Sends notifications to Notifiarr for media server management |