Call the CreateAlarmWebhookIntegration API to create a Webhook integration configuration.

Instructions for use

The call frequency limit for this interface is 20 times per second. If the frequency limit is exceeded, the error ExceedQPSLimit will be returned.

TLS alerting supports the following security configurations.

Feishu and DingTalk channels

Custom keywords

If custom keywords are configured in Feishu or DingTalk bots, you must include at least one of these keywords in the alert notification content of TLS. When using this method, it is recommended to set one of the keywords to 'alert' on the DingTalk or Feishu side.

Signature verification

If a signing key is configured in the Feishu or DingTalk bot, you must enter the signing key in the Webhook integration configuration on the TLS side.

Other custom webhook addresses

Perform authorization via the HTTP request header by adding "Authorization": "Bearer ${token}" to the header, where you need to replace ${token} with your custom token.

Note

Request method: POST

Request URL: https://tls-{Region}.ivolces.com/CreateAlarmWebhookIntegration

Request parameters

The following table 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	Array of GeneralWebhookHeaderKV	No	/	Custom Webhook request header. Required when WebhookType is set to GeneralWebhook.
WebhookMethod	String	No	POST	Custom Webhook request methods. Only POST and PUT are supported.
WebhookName	String	Is	test-alarm-integration	The webhook integration configuration name For naming rules, please refer to the resource naming rules.
WebhookSecret	String	No	/	Webhook encryption key. Set WebhookType to Lark, and when you set Security Settings to Signature Verification in the Feishu bot, you must enter the signature key of the Feishu bot here. For detailed instructions, please refer to the Custom bot user guide. When WebhookType is set to DingTalk and a signature value has been configured in the DingTalk bot, you must enter the DingTalk bot's signature value here. For detailed instructions, refer to Robot development.
WebhookType	String	Is	Lark	Webhook type. GeneralWebhook: Custom Webhook address. Lark: Lark. 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	Custom request header key.
value	String	No	application/json	The value of the custom request header.

Return parameters

The following table lists only the return parameters specific to this interface. For more information, see Return structure.

Parameter	Type	Example value	Description
AlarmWebhookIntegrationId	String	1f4a9e21****	The Webhook integration configuration ID.

Request example

Return example

Error codes

You can visit the public error codes page to obtain more information about error codes.

Torch Log Service