Webhook
Webhook allow you to post alerts directly from your devices to your application or any third party of your choosing.

Overview

Webhooks can be used to post requests into a third-party webhook of any kind.
The template consists of a JSON payload that contains the device details along with any custom headers of your choosing.
If the Webhook channel does not receive any request within 3 attempts, it will be marked as invalid and will stop further attempts.

Webhook URL

The URL that will receive the post requests with the JSON payload.

Scheme

You may create a custom JSON payload by defining your desired scheme.
The Scheme can also contain custom parameters by defining additional variables with our syntax, or using our own default generated scheme.
List of available variables that can be used inside the scheme:
Variable
Value
"{{ALERT_NAME}}"
The name of the alert
"{{ALERT_TYPE}}"
Alert monitor type: (resources, application, process)
"{{ALERT_VALUE}}"
The alert trigger value
"{{STATE}}"
Whether the alert was Trigger or Finished
"{{DEVICE_IP}}"
The last IP of the device
"{{DEVICE_ID}}"
The device ID
"{{DEVICE_NAME}}"
The name of the device
"{{DEVICE_GROUP}}"
The device closest nested group
"{{DEVICE_PROJECT}}"
The project that the device belongs to
"{{DEVICE_ADDRESS}}"
The address according to the IP of the device
"{{DESTINATION}}"
The Webhook Channel URL
"{{DASHBOARD_LINK}}"
Platform link to observe further information about the alert
"{{ALERT_TIMESTAMP}}"
The triggered/finished time of the alert
"{{TRIGGERED_VALUE}}"
The value that was initially triggered for

Custom Headers

You may add any custom header of your choosing. our default header is Content-type: application/json.

Pre-made Webhook templates

Slack

Reach out to Slack for configuring your application and receiving a unique URL, for additional information: https://api.slack.com/messaging/webhooks.
When Slack is configured, you can use the provided URL as the Webhook URL.
Example Slack Payload
{
"attachments":[{
"ts": "{{ALERT_TIMESTAMP}}",
"color": "#cc0000",
"title": ":frog: {{ALERT_NAME}}",
"fields":
[{
"short": false,
"title": "Alert Type",
"value": "{{ALERT_TYPE}}"
},
{
"short": true,
"title": "Configuration value",
"value": "{{ALERT_VALUE}}"
},
{
"short": true,
"title": "Actual value",
"value": "{{TRIGGERED_VALUE}}"
},
{
"short": true,
"title": "Device name",
"value": "{{DEVICE_NAME}}"
},
{
"short": true,
"title": "Device id",
"value": "{{DEVICE_ID}}"
},
{
"short": true,
"title": "Project",
"value": "{{DEVICE_PROJECT}}"
},
{
"short": true,
"title": "Group",
"value": "{{DEVICE_GROUP}}"
},
{
"short": true,
"title": "Device location",
"value": "{{DEVICE_ADDRESS}}"
},
{
"short": true,
"title": "IP Address",
"value": "{{DEVICE_IP}}"
}],
"pretext": "You have a {{STATE}} alert",
"mrkdwn_in": ["text"],
"title_icon": "https://findicons.com/files/icons/624/zoom_eyed_creatures/128/frog.png",
"title_link": "{{DASHBOARD_LINK}}"
}]
}

PagerDuty

First, you need to create a service with event API integration, for additional details reach out to: https://support.pagerduty.com/docs/services-and-integrations.
When the service is created you would receive a service key, the service key is to be inserted into routing_key.
Example PagerDuty Payload:
{
"payload": {
"summary": "You have a {{STATE}} alert - {{ALERT_NAME}} for device {{DEVICE_NAME}}",
"timestamp": "2015-07-17T08:42:58.315+0000",
"source": "monitoringtool:cloudvendor:central-region-dc-01:852559987:cluster/api-stats-prod-003",
"severity": "info",
"component": "postgres",
"group": "{{DEVICE_GROUP}}",
"class": "{{ALERT_TYPE}}",
"custom_details":
{
"Device name": "{{DEVICE_NAME}}",
"Device ID": "{{DEVICE_ID}}",
"Device project": "{{DEVICE_PROJECT}}",
"Device group": "{{DEVICE_GROUP}}",
"Device location": "{{DEVICE_ADDRESS}}",
"Device IP Address": "{{DEVICE_IP}}",
"Alert name": "{{ALERT_NAME}}",
"Alert type": "{{ALERT_TYPE}}",
"Configuration value": "{{DEVICE_PROJECT}}",
"Actual value": "{{DEVICE_GROUP}}"
}
},
"routing_key": Your SERVICE_KEY,
"dedup_key": "{{DEVICE_ID}}_{{ALERT_ID}}",
"images": [{
"src": "https://uploads-ssl.webflow.com/611ba30e0c70a64ebb003853/628a41f9136f611aa0a1ab6a_jfrog-logo.png",
"href": "https://example.com/",
"alt": "Dashboard"
}],
"links": [{
"href": "https://example.com/",
"text": "Dashboard"
}],
"event_action": "trigger"
}
Copy link
On this page
Overview
Webhook URL
Scheme
Custom Headers
Pre-made Webhook templates
Slack
PagerDuty