Webhook Detection Service

Allows developers to detect the availability of the GPTBots webhook service and the availability of the webhook URLs configured on a target Agent.

Detect the availability of the webhook services configured on an Agent

GPTBots allows developers to detect, via API, the availability of all Webhook URLs configured on a target Agent, including the webhook URLs configured for receiving "Send Message" and "Human handoff service - webhook". When a developer calls this API, GPTBots automatically detects all Webhook URLs configured on the Agent that the current API Key belongs to, with no need to specify a detection target, and returns the detection result for each Webhook item by item in the response.
The developer Webhook services involved by the istest field are as follows:

• The request body of the Send Message API responding to a webhook contains this field. View details
• The request body for receiving human service conversation request notifications and user messages contains this field. View details

When a developer's Webhook service receives a request, it should identify the istest field in the message body: when istest=true, it is an availability test request and should not be processed as a real business message (e.g. do not store it, do not trigger human service, etc.), and returning HTTP status code 200 indicates that the Webhook is available.

Request Method

POST

Request URL

https://api-${endpoint}.gptbots.ai/v1/webhook/check

Request Authentication

For details, refer to the authentication instructions in API Overview. This API identifies the target Agent by the API Key and detects the Webhooks configured under that Agent.

Request

Request Example

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/webhook/check' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json'

                    

Request Headers

Request Parameters

This API requires no request parameters. GPTBots automatically detects all Webhook URLs configured on the Agent that the current API Key belongs to.

Response

Response Example

                      
                      {
  "results": [
    {
      "type": "message",
      "component_id": null,
      "component_name": null,
      "webhook_url": "https://your_domain/webhook/message",
      "reachable": true,
      "http_status": 200,
      "latency_ms": 156
    },
    {
      "type": "human_service",
      "component_id": "665d88b03ce2b13cf2d57346",
      "component_name": "人工服务-售前",
      "webhook_url": "https://your_domain/presale/human/service/conversation/establish",
      "reachable": true,
      "http_status": 200,
      "latency_ms": 188
    },
    {
      "type": "human_service",
      "component_id": "665d88b03ce2b13cf2d57347",
      "component_name": "人工服务-售后",
      "webhook_url": "https://your_domain/aftersale/human/service/conversation/establish",
      "reachable": false,
      "http_status": 502,
      "latency_ms": 3000
    }
  ]
}

                    

Success Response

Availability Determination Suggestion

GPTBots sends a detection request carrying istest=true to the Webhook URL in the standard message format, and determines availability based on the returned result:

Failure Response

Error Codes

GPTBots Webhook Service Status Detection

GPTBots provides a health monitoring API for detecting the webhook service. Developers can call this API to probe whether the GPTBots webhook service is working normally. If the API returns HTTP status code 200 and the response body is an English indicator of normal service (such as service is normal), it means the GPTBots webhook service is working normally. This API requires no authentication and returns plain text.

Request Method

GET

Request URL

https://api.gptbots.ai/v1/webhook/service/health

Request Example

                      
                      curl -X GET 'https://api.gptbots.ai/v1/webhook/service/health'

                    

Response

When the GPTBots service is working normally, it returns HTTP status code 200, and the response body returns an English indicator of normal service.

                      
                      service is normal

                    

Availability Determination Suggestion

The caller only needs to use the HTTP status code as the criterion:

It is recommended to set a reasonable request timeout (e.g. 3-5 seconds) and probe by polling at a fixed frequency (QPM:3); this API requires no authentication, so there is no need to carry an API Key when calling it.