Services Overview¶

Chat Services¶

Click on the service for a more thorough explanation.

Service	URL format
Discord	discord://`TOKEN`@`WEBHOOK_ID`[?thread_id=`THREAD_ID`]
Google Chat	googlechat://chat.googleapis.com/v1/spaces/`SPACE_ID`/messages?key=`KEY`&token=`TOKEN`
Hangouts*	hangouts://chat.googleapis.com/v1/spaces/`SPACE_ID`/messages?key=`KEY`&token=`TOKEN`
Lark	lark://`HOST`/`TOKEN`[?secret=`SECRET`][&title=`TITLE`][&link=`LINK`]
Matrix	matrix://[`USER`]:`PASSWORD`@`HOST`[:`PORT`]/[?rooms=`ROOM_1`[,`ROOM_2`]]
Mattermost	mattermost://[`USERNAME`@]`HOST`/`TOKEN`[/`CHANNEL`]
Rocketchat	rocketchat://[`USERNAME`@]`HOST`/`INTEGRATION_ID`/`TOKEN`[/`CHANNEL`\|@`USER`]
Signal†	signal://[`USER`[:`PASSWORD`]@]`HOST`[:`PORT`]/`SOURCE_PHONE`/`RECIPIENT_1`[/`RECIPIENT_2`/...]
Slack	slack://{hook\|xoxb}:`TOKEN`@`CHANNEL`[?botname=`BOT_NAME`]
Teams	teams://?host=`WORKFLOW_URL`
Telegram	telegram://`TOKEN`@telegram?chats=`CHAT_1`[,`CHAT_2`,...]
WeCom	wecom://`KEY`
XMPP	xmpp://`USER`:`PASSWORD`@`HOST`[:`PORT`]/?to=`JID`[&rooms=`ROOM_JID`] or xmpps://`USER`:`PASSWORD`@`HOST`[:`PORT`]/?to=`JID`[&rooms=`ROOM_JID`]
Zulip Chat	zulip://`BOT_MAIL`:`BOT_KEY`@`HOST`/[?stream=`STREAM`][&topic=`TOPIC`]

* Deprecated

† A group ID can contain / and span several path segments, ending at the next phone number, username, or group ID. For example, signal://localhost:8080/+18005550100/group.ABCD/EFGH=/+18005550101 sends to the group group.ABCD/EFGH= and the phone number +18005550101.

Push Services¶

Service	URL format
Bark	bark://:`DEVICE_KEY`@`HOST`[:`PORT`][/`PATH`]
Gotify	gotify://`HOST`[:`PORT`][/`PATH`]/`TOKEN`
Home Assistant	homeassistant://`LONG_LIVED_TOKEN`@`HOST`[:`PORT`][/`BASE_PATH`]
IFTTT	ifttt://`KEY`/?events=`EVENT_1`[,`EVENT_2`,...][&value1=`VALUE_1`][&value2=`VALUE_2`][&value3=`VALUE_3`]
Join	join://shoutrrr:`API_KEY`@join/?devices=`DEVICE_ID_1`[,`DEVICE_ID_2`,...][&icon=`ICON`][&title=`TITLE`]
MQTT	mqtt://[[`USERNAME`][:`PASSWORD`]@]`HOST`[:`PORT`]/`TOPIC`
Ntfy	ntfy://[`USERNAME`:`PASSWORD`@]`HOST`/`TOPIC`
Pushbullet	pushbullet://`API_TOKEN`[/`DEVICE`/#`CHANNEL`/`EMAIL`]
Pushover	pushover://shoutrrr:`API_TOKEN`@`USER_KEY`/[?devices=`DEVICE_1`[,`DEVICE_2`,...]]
Signalgrid	signalgrid://`CLIENT_KEY`@`CHANNEL`

Incident Services¶

Service	URL format
OpsGenie	opsgenie://[`HOST`]/`API_KEY`[?responders=`RESPONDER_1`[,`RESPONDER_2`]]
PagerDuty	pagerduty://[`HOST`[:`PORT`]]/`INTEGRATION_KEY`[?`QUERY_PARAMETERS`]

Email Services¶

Service	URL format
Email	smtp://[`USERNAME`[:`PASSWORD`]@]`HOST`[:`PORT`]/?fromaddress=`FROM_ADDRESS`&toaddresses=`TO_ADDRESS_1`[,`TO_ADDRESS_2`,...][&`QUERY_PARAMETERS`]

SMS Services¶

Service	URL format
Twilio	twilio://`ACCOUNT_SID`:`AUTH_TOKEN`@`FROM_NUMBER`/`TO_NUMBER_1`[/`TO_NUMBER_2`/...]

Specialized Services¶

Service	Description
Generic Webhook	Sends notifications directly to a webhook
Logger	Writes a notification to a configured Go `log.Logger`
Notifiarr	Sends notifications to Notifiarr for media server management

Lists¶

Settings that take a list, such as Telegram's chats or the recipients in a Signal or Twilio URL path, leave out empty entries. A trailing comma, a doubled comma, or an empty path segment adds nothing, so chats=@alerts, sends to @alerts alone. A list whose entries are all empty counts as left out.