Webhook Notification

AimBetter supports integration with external platforms through webhook-based alert notifications. This feature enables customers to receive real-time alerts in their own monitoring or notification systems.

To set up webhook-based alert notifications, please contact our support team at [email protected] and provide the necessary configuration details as outlined below.

Webhook Configuration

1. Webhook URL

• Customers must provide a valid URL (including HTTPS).
• URL parameters can be included using the ?parameter=value syntax.
• The webhook request will use the HTTP POST method.
• The alert data will be sent in JSON format.

Example: https://example.com/alert-receiver?source=aimbetter


2. Payload Customization

Customers can customize the structure of the payload. The following customization options are available:

• Rename any default key.
• Remove any keys that are not needed.
• Add custom static key-value pairs (these values will not be updated dynamically by AimBetter).

3. Header Customization

AimBetter supports adding custom data to the HTTP headers:

• Any number of custom header fields can be added.
• A token (such as a bearer token or API key) can be included for authentication purposes.

Default Payload Structure

Below is the default JSON payload sent by AimBetter when an alert is triggered:

{
  "Server_name": "{Server_name}",
  "Account_Name": "{Account_Name}",
  "Group_Name": "{Group_Name}",
  "Server_Type": "{Server_Type}",
  "Server_Type_Id": "{Server_Type_Id}",
  "Rule": "{Rule}",
  "Rule_id": "{Rule_id}",
  "Level_Id": "{Level_Id}",
  "Level": "{Level}",
  "Start_Time": "{Start_Time}",
  "Start_time_unix": "{Start_time_unix}",
  "Update_Time": "{Update_Time}",
  "Update_time_unix": "{update_time_unix}",
  "Period_Description": "{Period_Description}",
  "Period_in_sec": "{Period_in_sec}",
  "Component": "{Component}",
  "Description": "{Description}",
  "Serial": "{Serial}",
  "Value": "{Value}",
  "Status": "{Status}",
  "Status_Id": "{Status_Id}",
  "Tag_name": "{Tag_name}",
  "alert_id": "{alert_id}"
}

Key	Description	Possible Values / Notes
Server_name	The name of the server where the alert was triggered.	Example: "SQL-PROD01"
Account_Name	The name of the customer account in AimBetter.	Example: "Acme Corp"
Group_Name	The group or environment name (e.g., Production, QA) associated with the server.	Example: "Production"
Server_Type	A descriptive type of the server.	Example: "MSSQL"
Server_Type_Id	Internal numeric ID representing the server type.	1 = Windows, 2 = MSSQL, 3 = IIS, 4 = ORACLE, 6 = LINUX, 7 = MYSQL, 8 = Azure/Amazon RDS, 9 = Connection, 10 = MSSQL_Managed, 11 = Redis
Rule	The name of the alert rule that was triggered.	Example: "High CPU Usage"
Rule_id	The internal unique ID of the triggered alert rule.	Integer value
Level_Id	Internal ID indicating the severity level of the alert.	0 = Info, 1 = Low, 2 = Medium, 3 = Critical
Level	Human-readable severity level of the alert.	Corresponds to Level_Id (e.g., "Critical")
Start_Time	The time when the alert condition was first detected.	Formatted timestamp (e.g., "2025-05-29T12:34:56Z")
Start_time_unix	The Unix timestamp for Start_Time.	Example: 1716986096
Update_Time	The last time the alert status was updated.	Formatted timestamp
Update_time_unix	The Unix timestamp for Update_Time.	Example: 1716986296
Period_Description	Describes how long the alert has been active.	Example: "15 minutes"
Period_in_sec	Duration the alert has been active, in seconds.	Example: 900
Component	The monitored component that triggered the alert.	Example: "CPU", "SQL Query", "Disk IO"
Description	Textual description of the problem.	Example: "CPU usage exceeded 95% for more than 10 minutes"
Serial	Unique identifier for the alert instance.	Disk “C”
Value	The measured value that caused the alert.	Example: "98%", "12000ms"
Status	Current status of the alert.	"Ended" or "Active"
Status_Id	Numeric representation of the status.	0 = Ended, 1 = Active
Tag_name	Optional tag for categorization.	Example: "CustomerX-SQL"
alert_id	AimBetter’s unique ID for this alert event.	Integer value