Skip to content

Custom Webhook

Overview

Aloudata CAN message push supports custom Webhooks. This document describes the JSON data format for custom Webhook message push, which is used to send monitoring alert information to specified recipients.

Basic Format

Push data is sent as a UTF-8 encoded JSON payload through an HTTP POST request.

Field Description

Field Type Required Description
pushId String Yes Unique identifier of the push message, used for tracking and deduplication
monitorId String No Monitoring task ID. It can be an empty string
receiverAccountList String Yes List of message recipient accounts. Separate multiple accounts with English commas and wrap the account list in double quotation marks
channel String Yes Push channel identifier. The example uses "cu"
triggerTime String Yes Alert trigger time in the format YYYY-MM-DD HH:mm:ss
content String Yes Alert content details, including monitoring metric information and alert status

JSON Format Example

{
  "pushId": "700baaa5d39647f3a0812f48d6286462",
  "monitorId": "",
  "receiverAccountList": "\"account1,account2,account3\"",
  "channel": "cu",
  "triggerTime": "2025-04-11 11:27:08",
  "content": "As of 2025-04-11 11:27:08, the result of the metric AtomicTest that you follow is Alert condition not matched. Matched alert condition: - \nPlease review it promptly. The metric owner is admin"
}