tencent cloud

APIs

DocumentationAPIsCloud Security CenterNotification Center APIsModifyWebhookReceiver

ModifyWebhookReceiver

Download
Focus Mode
Font Size
Last updated: 2026-09-01 10:18:56

1. API Description

Domain name for API request: csip.intl.tencentcloudapi.com.

Add or modify a receiving robot. ID > 0 means modifying an existing record; ID = 0 or not passed means adding new. The robot type is determined by the Type field. When Type=WEBHOOK, WebhookAddr is required. When Type=SCF, SCFRegion/Namespace/FunctionName/FunctionVersion/Alias/MaxWaitSeconds are all required. Type is not allowed to be changed during modification.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: ModifyWebhookReceiver.
Version Yes String Common Params. The value used for this API: 2022-11-21.
Region No String Common Params. This parameter is not required.
Name Yes String

Bot name
Input limits: 1-20 characters in length, tenant-unique
Type Yes String

Robot type
Enumeration values:
WEBHOOK: webhook type
SCF: function type
ID No Integer

Robot ID. More than 0 means modifying existing records; equal to 0 or not passed means adding new
Default value: 0
WebhookAddr No String

Webhook address
Input parameter limit: required when Type=WEBHOOK, length 1-2048, must be a valid http(s) URL, and intranet addresses are not allowed
SCFRegion No String

Function region, for example, ap-guangzhou
Input limit: required when Type is SCF
Namespace No String

Function namespace
Input parameter limit: required when Type=SCF
Value for reference: obtain through the DescribeSCFNamespaceList API
FunctionName No String

SCF function name
Input parameter limit: required when Type=SCF
Parameter value reference: obtain through the DescribeSCFFunctionList API
FunctionVersion No String

Function version
Input parameter limit: required when Type is SCF, for example $LATEST
Parameter value for reference: obtain through the DescribeSCFFunctionVersionList API
Alias No String

Function alias
Input parameter limit: required when Type=SCF, for example, $DEFAULT
Parameter value for reference: obtain through the DescribeSCFAliasList API

3. Output Parameters

Parameter Name Type Description
ID Integer

Newly-added or modified robot ID
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Example

Input Example

POST / HTTP/1.1
Host: csip.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyWebhookReceiver
<Common request parameters>

{
    "Name": "f2",
    "Type": "SCF",
    "SCFRegion": "ap-guangzhou",
    "Namespace": "default",
    "FunctionName": "f2",
    "FunctionVersion": "$LATEST",
    "Alias": "alias2"
}

Output Example

{
    "Response": {
        "ID": 21,
        "RequestId": "72c22c12-d0e3-4c35-928c-64225477dc46"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

There is no error code related to the API business logic. For other error codes, please see Common Error Codes.

Previous Topic: ModifyWebhookPolicyStatusNext Topic: TestWebhookReceiver

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback