Skip to content

Commit 15cbf08

Browse files
committed
formatted external notification service samples
1 parent 082e567 commit 15cbf08

1 file changed

Lines changed: 91 additions & 63 deletions

File tree

docs/Installation/Server Settings.md

Lines changed: 91 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -85,77 +85,105 @@ Placeholders:
8585

8686
Placeholders will be substituted on the URL, Header Values, and Body when the notification is sent out. All notifications are sent out as a POST method so a request body is always expected.
8787

88-
#### Sample NTFY Service Notification
88+
??? info "Sample NTFY Service Notification"
8989

90-
```
91-
Content Type: text/plain
92-
Not Urgent: 1
93-
Urgent: 3
94-
Very Urgent: 4
95-
Past Due: 5
96-
Headers:
97-
{
98-
"Click": "{link}",
99-
"Priority": "{priority}",
100-
"Title": "{title}"
101-
}
102-
Body:
103-
{message}
104-
```
90+
Content Type: `text/plain`
10591

106-
#### Sample Gotify Service Notification
92+
Priority Mapping:
10793

108-
```
109-
Content Type: application/json
110-
Not Urgent: 0
111-
Urgent: 3
112-
Very Urgent: 5
113-
Past Due: 10
114-
Headers:
115-
{}
116-
Body:
117-
{
118-
"title": "{title}",
119-
"message": "{message}",
120-
"priority": {priority},
121-
"extras": {
122-
"client::notification": {
123-
"click": {
124-
"url": "{link}"
125-
}
94+
| Urgency | Value |
95+
|---|---|
96+
|Not Urgent|1|
97+
|Urgent|3|
98+
|Very Urgent|4|
99+
|Past Due|5|
100+
101+
Headers:
102+
```
103+
{
104+
"Click": "{link}",
105+
"Priority": "{priority}",
106+
"Title": "{title}"
126107
}
127-
}
128-
}
129-
```
108+
```
130109

131-
#### Sample Discord Webhook Service Notification
132-
```
133-
Content Type: application/json
134-
Not Urgent: 1673044
135-
Urgent: 16761095
136-
Very Urgent: 14431557
137-
Past Due: 7107965
138-
Headers:
139-
{}
140-
Body:
141-
{
142-
"username": "LubeLogger",
143-
"avatar_url": "https://hargata.github.io/hargata/lubelogger_logo_small.png",
144-
"content": "{message}",
145-
"embeds": [
110+
Body:
111+
```
112+
{message}
113+
```
114+
115+
??? info "Sample Gotify Service Notification"
116+
117+
Content Type: `application/json`
118+
119+
Priority Mapping:
120+
121+
| Urgency | Value |
122+
|---|---|
123+
|Not Urgent|0|
124+
|Urgent|3|
125+
|Very Urgent|5|
126+
|Past Due|10|
127+
128+
Headers:
129+
```
130+
{}
131+
```
132+
133+
Body:
134+
```
146135
{
147136
"title": "{title}",
148-
"url": "{link}",
149-
"description": "{message}",
150-
"color":{priority},
151-
"author": {
152-
"name": "LubeLogger",
153-
"url": "{domain}",
154-
"icon_url": "https://hargata.github.io/hargata/lubelogger_logo_small.png"
137+
"message": "{message}",
138+
"priority": {priority},
139+
"extras": {
140+
"client::notification": {
141+
"click": {
142+
"url": "{link}"
143+
}
144+
}
155145
}
156146
}
157-
]
158-
}
159-
```
147+
```
148+
149+
??? info "Sample Discord Webhook Service Notification"
150+
151+
Content Type: `application/json`
152+
153+
Priority Mapping:
154+
155+
| Urgency | Value |
156+
|---|---|
157+
|Not Urgent|1673044|
158+
|Urgent|16761095|
159+
|Very Urgent|14431557|
160+
|Past Due|7107965|
161+
162+
Headers:
163+
```
164+
{}
165+
```
166+
167+
Body:
168+
```
169+
{
170+
"username": "LubeLogger",
171+
"avatar_url": "https://hargata.github.io/hargata/lubelogger_logo_small.png",
172+
"content": "{message}",
173+
"embeds": [
174+
{
175+
"title": "{title}",
176+
"url": "{link}",
177+
"description": "{message}",
178+
"color":{priority},
179+
"author": {
180+
"name": "LubeLogger",
181+
"url": "{domain}",
182+
"icon_url": "https://hargata.github.io/hargata/lubelogger_logo_small.png"
183+
}
184+
}
185+
]
186+
}
187+
```
160188

161189
Next Steps: [Configuring Authentication](/Installation/Authentication)

0 commit comments

Comments
 (0)