RunNotifyComponentWithWebhook - Security Center - Alibaba Cloud Documentation Center

Sends a message from a notification component using a webhook.

Operation description

Before you call this operation, make sure that you understand the billing methods and pricing of response orchestration. This feature is billed based on the log traffic for threat analysis and response.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:RunNotifyComponentWithWebhook

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Webhook	string	Yes	The IDs of the DingTalk robots. Obtain the IDs on the robot management page in Message Center.	[\"10651\"]
Secret	string	No	The secret key for the webhook of the DingTalk group robot. This parameter is deprecated and no longer used.	SECc1***e157b32b380f******bb8c70e1a67a22072
MsgType	string	Yes	The message type of the webhook. Valid values: text markdown actionCard	text
Content	string	Yes	The content of the message sent by the webhook of the DingTalk group robot.	{ "at": { "atMobiles":[ "180xxxxxx" ], "atUserIds":[ "user123" ], "isAtAll": false }, "text": { "content":"1234" }, "msgtype":"text" }
PlaybookUuid	string	Yes	The UUID of the playbook. Note Call the DescribePlaybooks operation to obtain this parameter.	94bc318c-**-4cba-**-801ccb0d739f
NodeName	string	Yes	The name of the playbook node.	notify_message_node
ComponentName	string	Yes	The name of the playbook component.	NotifyMessage
ActionName	string	Yes	The name of the playbook action.	notifyByCustom
AssetId	string	No	The ID of the resource. This parameter is deprecated and no longer used.	1
Lang	string	No	The language of the request and response. Valid values: zh (default): Chinese. en: English.	zh
RoleType	string	No	The view type. Valid values: 0 (default): the view of the current Alibaba Cloud account. 1: the view of all accounts that belong to the enterprise.	0
RoleFor	integer	No	The UID of the member that the administrator wants to switch to.	126339xxxx805497

Response elements

Element	Type	Description	Example
	object	SophonResult
RequestId	string	The ID of the request.	E7698CFB-****-5840-8EC9-691B86729E94
Data	string	The data returned.	{}
Page	object	The pagination information.
TotalCount	integer	The total number of entries returned. This parameter is available only for paged queries.	30
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries per page.	10

Examples

Success response

JSON format

{
  "RequestId": "E7698CFB-****-5840-8EC9-691B86729E94",
  "Data": "{}",
  "Page": {
    "TotalCount": 30,
    "PageNumber": 1,
    "PageSize": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.