Implementation of webhook alerts

[henrygd]

Update: This has been added in 0.4.0 using Shoutrrr

As with the additional disks thread (#36), this is a feature I plan to add at some point and want to source opinions on the best way to go about it.

I don't have enough free time to do custom implementations for every possible service. So I'm thinking something like the mock up below would work for the largest number of applications.

You would have {{title}} and {{body}} variables that would match the title and body of email alerts. This should allow you a bit of freedom in how you format the message. Including using JSON for the body.

I'd like to know if this absolutely won't work for anyone. And I'm open to suggestions. But again, I want to avoid writing custom code to support specific services.

[henrygd]

Also, this would be defined universally for each user. You wouldn't need to set it up for every alert. We could have a toggle for enabling / disabling. If it's enabled, it will send automatically for every alert.

[cichy1173]

Hello. Yes. Webhooks alerts will cover most of notification systems used in selfhosted world (as far as I see on social media) - for example, ntfy, Telegram bots or Home Assistant (maybe even Pagerduty if set in right way). That should cover most of use cases. Maybe somewhere in the future it would be good to add support for MQTT, but Webhooks will get job done.

Right now only way to get notification about an alert is creating some grabber service, that will check for triggered alerts from frontend side, get alert data and do something with this which I see is supported thanks to PocketBase, but it is not that straight forward like normal REST API with, ie curl calls.

[svenvg93]

I know from another project I worked on for notifications that depending on the service the payload might need to be diffrent. For example Discord expects "content" followed by the message, where ntfy expects "message" and Slack expexts "text" . Just my to cents.

[henrygd]

In the request body, right? In theory this approach should still work by putting the JSON content in the body field:

{
    "topic": "mytopic",
    "message": "{{body}}",
    "title": "{{title}}",
    "tags": ["warning"],
    "priority": 4
}

[svenvg93]

Yess, If you look at discord it wants "content" for the body message instead message https://discord.com/developers/docs/resources/webhook#execute-webhook-jsonform-params

Slack expects "test" for the body message
https://api.slack.com/messaging/webhooks#posting_with_webhooks

It won't be a one webhook to cover them all unfortunately :(

[henrygd]

I might be missing your point. For discord couldn't you just change the field name to "content"?

{
    "content": "{{body}}"
}

[svenvg93]

Yess that what I meant ;). It was just a heads up :)

[Zottelchen]

Another way would be to integrate something like apprise (https://github.com/caronc/apprise). Not sure if there is a go library similar to it.
There seems to be PingMe (https://github.com/kha7iq/pingme), but the services seem rather limited.

[cw-cdz]

Another way would be to integrate something like apprise (https://github.com/caronc/apprise). Not sure if there is a go library similar to it. There seems to be PingMe (https://github.com/kha7iq/pingme), but the services seem rather limited.

I agree. Integrating with apprise or shoutrrr or /similiar would provide an easy way to support many different providers, and those projects also have extensibility features (plugins)

[Tohjuler]

Good idea, you could hook up a template system.
Then people could contribute with templates, that way it could be a good fit for all users both them that is not as advance as others.

[parnic]

Feels like it would be simplest to integrate shoutrrr support and let users define what notifier to use.

[parnic]

#145

[cichy1173]

Hi @henrygd . Thanks for adding sending alarms on webhook. I really like the feature. Also I see that I can add multiple webhooks, which is cool but I do not know how to take advantage of that. Is there a way to spread alarms across webhooks, for example, alarms from instance XYZ goes to webhook A, and alarms for instance ZYX goes to webhook B?

[henrygd]

Currently you would need to create a second user. Add them to system ZYX (in PocketBase - don't recreate it) and set up the alert with that user.

[cichy1173]

That's actually works. Thanks!

[FPille]

Signal webhook
generic://localhost:8080/v2/send?template=json&disabletls=yes&$number=%2B491111111&$recipient=%2B492222222

The credit goes to dpmpc
containrrr/shoutrrr#66 (comment)

[henrygd]

Nice, thanks! Good to know in case anyone asks.