Test Webhook Connectivity

Send a test message to a specified Webhook URL to test Webhook connectivity.

Request URL

GET {base_url}/{api_path}/webhook/test?access_token={access_token}

Request parameters

Parameter Required Type Description
url Yes String The URL of a configured Webhook.
Note: You can get the configured Webhook URLs using Query Webhook Event Push Settings.
secret Yes String Secret key corresponding to the specified Webhook URL.

The key is used to generate HMAC-SHA256 signatures for Webhook messages. The recipient can use the key to verify the message's authenticity and integrity.

Note: You can get the Webhook URL and its corresponding secret key using Query Webhook Event Push Settings.
request_method Yes String HTTP request method for sending requests to the Webhook URL.
Valid value:
  • GET
  • POST

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.

Examples

Request example

GET /openapi/v1.0/webhook/test?access_token=DEfChNyQmVMUZip90i8PqCfotJL7kIQB&request_method=POST&secret=qnIdTBxyGgn2LckZrFw7IVeTRMJf3XfM&url=https://webhook.site/38e9dea1-be68-4381-8a8c-f0623517f513 HTTP/1.1
Host: 192.168.5.150:8088

Response example

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}