Webhook template for gotify

[1RandomDev]

Is there already a webhook template for Gotify? If not I'd like to create my own one but I just can't find any information about what the file specified in webhook.template_path has to contain.

[davidnewhall]

The template stuff doesn't have any documentation. There are five working templates right here: https://github.com/davidnewhall/unpackerr/blob/master/pkg/unpackerr/webhooks_templates.go#L48-L221

Copy the data between the ticks (``) into a file and you now have a template file. Adjust it to your needs. When you get it working, lets discuss more. :) if you need help, lemme know!

Use the -w cli arg to test your changes. unpackerr -w 2 for instance will fire a test webhook.

[krystiancharubin]

I tried making a quick template, but seems like gotify does not like multiline strings, or they are not getting generated correctly. Tried using the text attribute from Telegram template for the message but get the same error.

2022/04/23 01:12:37.896993 webhook.go:119: [DEBUG] Webhook Payload: {
  "priority": 2,
  "title": "Unpackerr",
  "message": "Hello
  World",
  "extras": {
    "client::display": {
      "contentType": "text/markdown"
    }
  }
}
2022/04/23 01:12:37.897049 webhook.go:120: [ERROR] Webhook (/this/is/a/path = extracting): Gotify: invalid HTTP status reply (400 Bad Request): {"error":"Bad Request","errorCode":400,"errorDescription":"invalid character '\\n' in string literal"}

[davidnewhall]

Share your template so I can help provide ideas.
Might just need to use \n like this: https://github.com/davidnewhall/unpackerr/blob/master/pkg/unpackerr/webhooks_templates.go#L181

[krystiancharubin]

Yeah using Hello\nWorld works just harder to make a more complex template since it all will have to be on one line.

[davidnewhall]

Got any experience with Go? You could probably make it replace newlines with \n :)

[davidnewhall]

What you're experiencing is a JSON problem. Not anything specific to my code or this app. If you wrote a JSON blob and fed it into curl you'd have to do the same thing. EDIT: as mentioned in the previous comment, the app could "help" by "fixing" the JSON if it has newlines in it...

[krystiancharubin]

I've dabbled with go before, and yeah you are absolutely right that its a JSON problem. Just trying to see if there is an easy way to get around this with Go. Gotify allows sending notifications using url parameters, how would I make a template to generate url params like WebhookTemplatePushover. Do I just need to set content_type to something else.

Edit: I looked though the code and found you are using application/x-www-form-urlencoded for Pushover, got it to work with Gotify.

[krystiancharubin]

The following works, based on Pushover template. Wanted to do some markdown to add styling but thats only supported with json payloads in Gotify

UN_WEBHOOK_0_URL=https://gotify.example.com/message?token=REDACTED

title={{nickname}}: {{formencode .Event.Desc}}&message=App: {{.App}}
Name: {{formencode (index .IDs "title")}}
Path: {{formencode .Path}}
{{ if .Data -}}
{{ if .Data.Elapsed.Duration}}Time: {{.Data.Elapsed}}
{{end}}{{ if .Data.Archives}}RARs: {{len .Data.Archives}}
{{end}}{{ if .Data.Files}}Files: {{len .Data.Files}}
{{end}}{{ if .Data.Bytes}}Bytes: {{humanbytes .Data.Bytes}}
{{end}}{{ if and (gt .Event 1) (lt .Event 5)}}Queue: {{.Data.Queue}}
{{end}}{{ if .Data.Error}}
ERROR: {{formencode .Data.Error}}
{{end}}{{end -}}

[davidnewhall]

Lookin good. Can ya share a screenshot?

[krystiancharubin]

[krystiancharubin]

In the Telegram template the text attribute is defined over multiple lines, is that generating invalid JSON or does Go do something special since the template is defined inside the file?
https://github.com/davidnewhall/unpackerr/blob/280a04fe716b850084f65a3a3708c6856e4f5eb1/pkg/unpackerr/webhooks_templates.go#L75-L90

[davidnewhall]

In the Telegram template the text attribute is defined over multiple line

the - at the end (or beginning) of a template item {{ }} removes all trailing (or leading) spaces and newlines. You can use this to your advantage to cut up long strings. EDIT: Read more about it here: https://pkg.go.dev/text/template

[krystiancharubin]

<b><a href=\"https://github.com/davidnewhall/unpackerr/releases\">Unpackerr<a>: {{.Event.Desc}}</b> 
     \n<b>Title</b>: {{rawencode (index .IDs "title") -}} 
     \n<b>App</b>: {{.App -}} 
     \n\n<b>Path</b>: <code>{{rawencode .Path}}</code>

This bit is not within {{ }} and is split across multiple lines, with explicit \n

[davidnewhall]

Good question. It's producing invalid JSON. I'll have to test this more, but I suspect telegram is "Accepting and fixing" it.

2022/04/23 23:19:10.681473 webhook.go:123: [DEBUG] Webhook Payload: {
  "chat_id": "Unpackerr",
  "parse_mode": "HTML",
  "text": "<b><a href=\"https://github.com/davidnewhall/unpackerr/releases\">Unpackerr<a>: Extracting</b>
    \n<b>Title</b>: Some Cool Title Name Here\n<b>App</b>: Starr\n\n<b>Path</b>: <code>/this/is/a/path</code>
  \n
    \n <b>Archives</b>: 2\n <b>Queue</b>: 0"}

[davidnewhall]

Are you good with your template at this point? Would you like me to bake it into the app?