logo
Documentación
Buscar
Alert Notification

Alert Notification

Alert Type

image-20241226194156222

In GPTBots' "Organization - Alert Notifications," you can try out alert-related features.
The alert notification feature of GPTBots is divided into three types based on different business scenarios:

  • Quota Alert: Alert related to credits and subscription plans. Includes: credit balance alerts, credit consumption alerts, subscription plan alerts.
  • Agent Alert: Alert related to Agent business scenarios. Includes: Agent conversation RPM rate limit exceeded, Agent conversation RPM rate limit trigger count alerts, Agent conversation abnormal reply count rate limit exceeded alerts.
  • Issue Classification Alert: Alert related to scenarios involving the frequency of issue classifications during Agent interactions.

Alert Rule Configuration

Alert Items

image-20241226194534946

After selecting the alert type, click "Add Alert" under that type to start configuring the alert.

When configuring the alert, you need to select specific alert items. For example: point balance.
Please note that in business alerts, you need to select the target Agent. In categorical alerts, you need to select both the target Agent and the target issue classification.

Alert Rules

Alert rules are the conditions that trigger the alert. When the conditions are met, an alert will be triggered.

Notification Frequency

The notification frequency determines how often alerts are sent. Once an alert is triggered, users can configure the notification frequency themselves.

Notification Channels

image-20241226194739578

GPTBots supports four notification methods: Email, SMS, WhatsApp, and Webhook. You can select the notification methods and add members. When an alert is triggered, GPTBots will send it based on the selected methods and members' contact details.

Alert Webhook Configuration

This Webhook is used to receive alert notifications. Through a POST request, the client can send alert information, including the alert 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: webhookClientSecret
    Header 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 and webhookClientSecret are configured.
    Authorization Description
  • If both webhookClientId and webhookClientSecret exist, Basic authentication is used, with the format:
Authorization: Basic Base64(clientId:clientSecret)
                      
                      Authorization: Basic Base64(clientId:clientSecret)

                    
Este bloque de código en la ventana flotante
  • If only webhookClientId exists, Bearer authentication should be used in the following format:
Authorization: Bearer clientId
                      
                      Authorization: Bearer clientId

                    
Este bloque de código en la ventana flotante
  • If only webhookClientSecret exists, Bearer authentication should be used in the following format:
Authorization: Bearer clientSecret
                      
                      Authorization: Bearer clientSecret

                    
Este bloque de código en la ventana flotante

Request Body
The request body is in JSON format and includes the following fields:

Field Type Required Description
title String Yes alert title
time Long Yes alert timestamp (in milliseconds)
content String Yes Specific content of the alert
Example:
{ "title": "CPU Usage alert", "time": 1698745600000, "content": "The CPU usage has exceeded 90% for the last 5 minutes." }
                      
                      {
  "title": "CPU Usage alert",
  "time": 1698745600000,
  "content": "The CPU usage has exceeded 90% for the last 5 minutes."
}

                    
Este bloque de código en la ventana flotante

Notes

  1. 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).
  2. Authentication: If webhookClientId or webhookClientSecret is configured, authentication can be performed according to the corresponding method.
  3. Timeout Setting: The default request timeout is 5 seconds. If the target server does not respond within 5 seconds, the request will fail.

Alert Frequency Control

image-20241226194848985

In "Alert Frequency Control," you can configure the total amount of alert notifications sent through different channels and configure the language of alert notifications yourself.