summaryrefslogtreecommitdiff
path: root/views/webhook.pug
blob: ad6c75f60eac2c15b4ca6f64ec11fc01083690ef (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
//- vim:ts=4:sw=4:
doctype html
html(lang="en")
	head
		include head
		title Webhook
	body
		include header
		article

			h1 Webhook

			- var url = webhook && webhook.url || ""
			- var format = webhook && webhook.format || ""
			- var prefix = webhook && webhook.prefix || ""

			form(action="/update-webhook" method="post")
				if webhook && webhook.error
					p.error ERROR: #{webhook.error}
				p Webhook URL:
					br
					input#url(type="text" name="url" size=120 placeholder="https://discord.com/api/webhooks/..." value=url required)
				p Webhook format:
					br
					input#format(type="text" name="format" size=40 placeholder="content" value=format)

				p Message prefix:
					br
					input#prefix(type="text" name="prefix" size=40 placeholder="<@123456789>" value=prefix)

				if webhook
					button(type="submit") Update
				else
					button(type="submit") Create

			if webhook
				form(action="/delete-webhook" method="post")
					button(type="submit") Delete

			h2 Discord Notifications

			p You can send notifications to a given channel on a Discord server.

			ol
				li Create your own server or use an existing server where you have administrator privileges.
				li <a href="https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks">Get the webhook URL</a> for the Discord channel and enter it into the Webhook URL field.
				li Enter "content" into the Webhook format field.
				li Find your <a href="https://support.playhive.com/discord-user-id/">Discord User ID</a>. This is not your username, it is a number.
				li Enter your Discord User ID into the Message prefix field as "&lt;@12345&gt;".

			h2 Slack Notifications

			p You can send notifications to a Slack workspace.

			ol
				li Join or set up a Slack workspace with a webhook integration.
				li Find the Webhook URL and enter it into the Webhook URL field.
				li Enter "text" into the Webhook format field.
				li Find your <a href="">Slack User ID</a>. This is a number with "U" in front of it.
				li Enter your Slack User ID into the Message prefix field as "&lt;@U12345&gt;".

			h2 Custom Notifications

			p.
				You can integrate with any server that accepts inbound webhooks by setting the webhook URL to the appropriate endpoint.
				If the format field is blank, the payload is sent as plain text.
				Otherwise, the payload is a JSON object where the format field specifies which JSON property holds the message.
				Use "content" for Discord and "text" for Slack.