Custom Webhook notifications

You can set your own webhook URL where you will receive POST request when your monitor status has been updated.

How to enable it

Go to our dashboard, click on edit monitor button, and then click on enable Webhook notifications button and enter your webhook URL. Your webhook URL must return 200 status code.

How to make your own webhook

You can use pipedream to make your webhook and to receive notifications on any service You can find Discord embed notifications example pipedream webhook which you can copy and modify here.

POST request format

We are sending POST request with the following body content in JSON (header Content-Type: application/json):

{
"monitor_name":"example monitor", // monitor name
"monitor_link":"https://example-monitor.pinglik.eu/", // monitor link
"monitor_owner_id":"Discord ID of owner", // your Discord ID
"monitor_owner_tag":"Discord tag of owner", // your Discord tag
"type":"online", // notification type - online, offline or down (when request has failed)
"status_code":200, // response status code
"status_text":"OK", // response status text
"timestamp": "YYYY-MM-DDTHH:mm:ss.sssZ" // actual timestamp in ISO 8601 format
"emoji":"🟢", // Emoji, it depends on the type - 🟢 (online), 🟠 (offline), 🔴 (offline)
"message":"🟢 Your monitor **example monitor** (https://example-monitor.pinglik.eu/) is **online**.\n> Status: **200** (**OK**)", // example message, you can use this when making custom notifications or you can make your own message using other values
"error":"Error message" // only when type is down (request has failed) - here will be fetch error message why it has failed
}

Notes

If your webhook does not work, you should disable webhook notifications to prevent our system from making useless requests.

If you are using your own webhook using webserver like express, make sure that the route name is some secure random generated string, or someone else can guess the webhook URL and send you fake notifications.

If request to your custom webhook URL has failed, our system may automatically disable notifications for you and you will need to enable it again on dashboard.

Last updated