WebHooks

Introduction

Web hooks are URLs which are called in response to an action or condition in an application. What the target of the URL does in repose depends entirely on its function. It could send an alert push message or and email or it could send restart commands to services such as Docker. This is a superbly flexible method of connecting items of functionality.

Calling web hooks

NUTCase defines web hooks in the configuration file with names and calls a web hook by that name under the following conditions:

Condition	WebHook Name	Status
App start	ok	up
App exit	fail	down
Configuration update	ok	up
Failed data grab	fail	down
Successful data grab	ok	up

The system is optimised to work with Uptime Kuma and as such it supports the status and msg fields to convey meaning. If you just use a generic web hook without these fields then the fields will be ignored and the hook will be called as normal.

You can either provide a web hook for each name (and therefore action) or use the default keyword name to have a single hook called by all actions.

When you supply a web hook for any name you can either have a single URL or a list of multiple URLs. This supports multiple service monitors from a single NUTCase instance.

For details on how to define web hooks please see the configuration file documentation.