You need to enable JavaScript to run this app.
Torch Log Service

Torch Log Service

Copy page
Download PDF
Alarm management API
ModifyAlarmWebhookIntegration
Copy page
Download PDF
ModifyAlarmWebhookIntegration
Call the ModifyAlarmWebhookIntegration API to modify the alarm webhook integration configuration.​
Notes​
The call rate limit for this interface is 20 times per second. If the rate limit is exceeded, an ExceedQPSLimit error will be returned.​
Note​
  • Request method: PUT​
  • Request URL: https://{tls-endpoint}/ModifyAlarmWebhookIntegration​
Request parameters​
The table below lists only the request parameters specific to this interface and some common parameters. For more information, see public parameters.​
Body​
​
Parameter​
Type​
Required​
Example value​
Description​
WebhookHeaders​
No​
/​
The custom Webhook request header is required when WebhookType is set to GeneralWebhook.​
WebhookID​
String​
Is​
1f4a9e21****​
Webhook integration configuration ID.​
WebhookMethod​
String​
No​
POST​
Only POST and PUT are supported as custom Webhook request methods.​
WebhookName​
String​
Is​
test-alarm-integration​
The webhook integration configuration name. For naming rules, please refer to Resource naming rules.​
WebhookSecret​
String​
No​
/​
Webhook encryption keys​
  • When WebhookType is set to Lark, and security settings are set to signature verification in the Feishu bot, you must enter the signature key for the Feishu bot here. For detailed instructions, please refer to Custom Bot User Guide.​
  • When WebhookType is set to DingTalk and a signature value has been configured in the DingTalk bot, you need to enter the DingTalk bot's signature value here. For detailed instructions, please refer to Develop robots.​
WebhookType​
String​
Is​
Lark​
Webhook types.​
  • GeneralWebhook: Custom Webhook address.​
  • Lark (Feishu).​
  • DingTalk: DingTalk.​
  • WeChat: WeCom.​
WebhookUrl​
String​
Is​
https://open.feishu.cn/open-apis/bot/v2/hook/****​
Webhook request address.​
​
GeneralWebhookHeaderKV​
​
Parameter​
Type​
Required​
Example value​
Description​
key​
String​
No​
Content-Type​
The key of a custom request header​
value​
String​
No​
application/json​
The value of the custom request header.​
​
Return parameters​
This API does not have any unique return parameters. For more information, see Return structure.​
Request example​
​
PUT https://tls-{Region}.bytepluses.com/ModifyAlarmWebhookIntegration HTTP/1.1​
Content-Type: application/json​
{​
"WebhookID": "3b0c6c7f****",​
"WebhookName": "yyj-test-lin",​
"WebhookType": "dingtalk",​
"WebhookUrl": "http://baidu.com",​
"WebhookSecret": "111"​
}​
​
Return example​
​
HTTP/1.1 200 OK​
Content-Type: application/json; charset=utf-8​
​
Error codes​
You can visit Public Error Codes to obtain more information about error codes.​
Last updated: 2025.10.28 18:42:04