Webhook Customization¶

Webhook Customization is a general-purpose alert notification method. You can push alert events generated by Guance to any system or platform that supports HTTP reception, enabling integration with internal operations systems, automation platforms, or third-party tools.

Configuration Steps¶

1. Define the name of the current notification target for identification in the notification target list;
2. Enter the HTTP endpoint URL that receives alert notifications. When a Monitor triggers an alert, Guance sends a POST request to this URL (❗️Make sure the Webhook URL you entered matches the selected notification platform type);
3. Select the members to be included with the notification;
4. Test whether the notification is sent as needed (❗️A test message is sent to the group/channel corresponding to this Webhook. Go to the corresponding notification target to check whether the test message was sent successfully);
5. Configure operation permissions;
6. Confirm.

Select Members¶

Select the members to be included with the notification. When a Webhook notification is sent, the selected member information is also sent externally, allowing third-party systems to assign permissions or route notifications based on members.

The selectable members here include all teams and workspace members in the current workspace:

Notification Content¶

The final Webhook event notification sent externally contains the following:

Event Information¶

bodyType is json text:

POST http://my-system/accept-webhook
Content-Type: application/json

{
    "timestamp"               : 1625638440,
    "df_status"               : "warning",
    "df_event_id"             : "event-xxxxxxxxxx",
    "df_title"                : "web001存在问题",
    "df_message"              : "web001存在问题\nCPU使用率大于90\n内存使用率大于90",
    "df_dimension_tags"       : "{\"host\":\"web001\"}",
    "df_monitor_id"           : "monitor_xxxxxxxxxx",
    "df_monitor_name"         : "异常检测名",
    "df_monitor_checker_id"   : "rul_xxxxxxxxxx",
    "df_monitor_checker_name" : "异常检测项目名",
    "df_monitor_checker_value": "99",
    "df_event_link"           : "https://console.guance.com/keyevents/monitorChart?xxxxxxxxxx"
    "df_workspace_uuid"       : "wksp_xxxxxxxxxx",
    "df_workspace_name"       : "我的工作空间",
    "Result"                  : 99,
    "...其他更多字段": "略",

    // The following are legacy fields
    "date"          : 1625638440,
    "workspace_uuid": "wksp_xxxxxxxxxx",
    "workspace_name": "我的工作空间",
}

Member Information¶

If members are configured, the Webhook synchronously passes the member information.

Automatically Append Workspace Attribute Claims¶

If the workspace has Attribute Claims configured, the relevant fields are automatically appended to the notification content.

For more details, see Attribute Claims.