Skip to content

Webhook Customization

Notification Details

The final outgoing Webhook event notification contains the following content:

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 has issues",
    "df_message"              : "web001 has issues\nCPU usage greater than 90\nMemory usage greater than 90",
    "df_dimension_tags"       : "{\"host\":\"web001\"}",
    "df_monitor_id"           : "monitor_xxxxxxxxxx",
    "df_monitor_name"         : "Anomaly Detection Name",
    "df_monitor_checker_id"   : "rul_xxxxxxxxxx",
    "df_monitor_checker_name" : "Anomaly Detection Item Name",
    "df_monitor_checker_value": "99",
    "df_event_link"           : "https://console.guance.com/keyevents/monitorChart?xxxxxxxxxx"
    "df_workspace_uuid"       : "wksp_xxxxxxxxxx",
    "df_workspace_name"       : "My Workspace",
    "Result"                  : 99,
    "...Other fields": "Omitted",

    // The following are legacy fields
    "date"          : 1625638440,
    "workspace_uuid": "wksp_xxxxxxxxxx",
    "workspace_name": "My Workspace",
}

Synchronously Append Workspace Attribute Claims

For more details, refer to Attribute Claims.

Select Members

When configuring Webhook notification targets, members can be selected. After this Webhook notification target rule takes effect, in addition to the two types of event information above, the Webhook will also send the member information entered in the current configuration to external parties. This facilitates subsequent third-party systems to perform different rule operations based on the member information.

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

Webhook custom notifications only support JSON format for the content. For details on each field, refer to Event Generation.

For more detailed practice documentation on Webhook customization, refer to Guance Webhook Custom Alert Notification Integration.

Feedback

Is this page helpful? ×