[webhook] clarify content of msg, heartbeatJSON and monitorJSON

[clement-igonet]

⚠️ Please verify that this feature request has NOT been suggested before.

• I checked and didn't find similar feature request

🏷️ Feature Request Type

New Notification

🔖 Feature description

I'm interested in customizing webhook notification with suggested msg, heartbeatJSON and monitorJSON

However, their content is not clear to me. When I look at the source code, I can see part of indications, but I'm not sure I reach the whole content. More documentation would be helpful and welcome.

For instance, is there a way to get a unique ID / fingerprint for a given up and down sequence ?

• Indeed, it would help a lot when sending the notification up or down to third party services that need it to know how to close an incident by a unique up/down reference.

✔️ Solution

Add inline documentation in webhook notification setup, or at least fill a content as a Test notification to see a whole heartbeatJSON or monitorJSON structure and content.

❓ Alternatives

No response

📝 Additional Context

No response

[CommanderStorm]

#3636 improved the documentation a bit, but currently this is difficult because some monitors have different information available.

Adding monitorJSON to the the test notification is something that we have not got around to yet.

If you have more concrete ideas how we can do this we would be very open to this ^^

Note that webhooks can be tested using https://webhook.site/

[joy4eg]

currently this is difficult because some monitors have different information available.

Yeah, that's understandable. But I think they all (should?) share some common information/fields. Like name, status or host.
It would be really nice to see them (common fields) in the test notification run.

[unlimitedsola]

Stumbled upon this. I'm shocked by how little documentation on the detailed structure of the heardbeatJSON and monitorJSON is.

Note that webhooks can be tested using https://webhook.site/

This would definitely be very helpful if the "test" button doesn't simply send null values.