Alarm Notification
Alarm Type
In GPTBots' "Organization - Alarm Notifications," you can try out alarm-related features.
The alarm notification feature of GPTBots is divided into three types based on different business scenarios:
- Quota Alarm: Alarm related to credits and subscription plans. Includes: credit balance alarms, credit consumption alarms, subscription plan alarms.
- Business Alarm: Alarm related to Agent business scenarios. Includes: Agent conversation RPM rate limit exceeded, Agent conversation RPM rate limit trigger count alarms, Agent conversation abnormal reply count rate limit exceeded alarms.
- Issue Classification Alarm: Alarm related to scenarios involving the frequency of issue classifications during Agent interactions.
Alarm Rule Configuration
Alarm Items
After selecting the alarm type, click "Add Alarm" under that type to start configuring the alarm.
When configuring the alarm, you need to select specific alarm items. For example: point balance. Please note that in business alarms, you need to select the target Agent. In categorical alarms, you need to select both the target Agent and the target issue classification.
Alarm Rules
Alarm rules are the conditions that trigger the alarm. When the conditions are met, an alarm will be triggered.
Notification Frequency
The notification frequency determines how often alarms are sent. Once an alarm is triggered, users can configure the notification frequency themselves.
Notification Channels
GPTBots supports four notification methods: Email, SMS, WhatsApp, and Webhook. You can select the notification methods and add members. When an alarm is triggered, GPTBots will send it based on the selected methods and members' contact details.
Alarm Webhook Configuration
This Webhook is used to receive alarm notifications. Through a POST request, the client can send alarm information, including the alarm title, time, and content, to the specified Webhook URL. Request URL
- URL: Dynamically configured Webhook URL
- Method:
POST
- Content-Type:
application/json
Request Headers Username: webhookClientId
Secret: webhookClientSecretHeader Required Description Content-Type Yes The content type of the request body, fixed as application/json
Authorization No This header is required if both webhookClientId
andwebhookClientSecret
are configured.Authorization Description - If both
webhookClientId
andwebhookClientSecret
exist, Basic authentication is used, with the format:
Authorization: Basic Base64(clientId:clientSecret)
- If only
webhookClientId
exists, Bearer authentication should be used in the following format:
Authorization: Bearer clientId
- If only
webhookClientSecret
exists, Bearer authentication should be used in the following format:
Authorization: Bearer clientSecret
Request Body The request body is in JSON format and includes the following fields:
Field | Type | Required | Description |
---|---|---|---|
title | String | Yes | alarm title |
time | Long | Yes | alarm timestamp (in milliseconds) |
content | String | Yes | Specific content of the alarm |
Example: |
{
"title": "CPU Usage alarm",
"time": 1698745600000,
"content": "The CPU usage has exceeded 90% for the last 5 minutes."
}
Notes
- Webhook URL Validation: The URL must be a valid external address and cannot point to an internal network address (e.g., 192.168.x.x or 10.x.x.x).
- Authentication: If
webhookClientId
orwebhookClientSecret
is configured, authentication can be performed according to the corresponding method. - Timeout Setting: The default request timeout is 5 seconds. If the target server does not respond within 5 seconds, the request will fail.
Alarm Frequency Control
In "Alarm Frequency Control," you can configure the total amount of alarm notifications sent through different channels and configure the language of alarm notifications yourself.