- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
管理 Webhook
- /
- 获取 Webhook 事件列表
¶ Get the list of Webhook events
Update time: 2025-07-23 07:34:21
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.
Returns event list and category list
¶ Method name
ManagementClient.get_webhook_event_list
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|
¶ Request response
Type: WebhookEventListRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful, 200 means success. |
| message | string | Description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (not returned for successful requests). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | WebhookEventListData | Response data |
Sample result:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"categories": {
"name": "User",
"nameEn": "User",
"value": "user"
},
"events": {
"name": "Create User",
"nameEn": "Create User",
"value": "user:created",
"category": "user"
}
}
}
¶ Data structure
¶ WebhookEventListData
| Name | Type | Is it required | Description | Sample value |
|---|---|---|---|---|
| categories | array | Yes | Category list Nested type: WebhookCategoryDto. | |
| events | array | Yes | Event list Nested type: WebhookEventDto. |
¶ WebhookCategoryDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| name | string | Yes | Webhook type name | User |
| nameEn | string | Yes | Webhook type English name | User |
| value | string | Yes | Webhook type | user |
¶ WebhookEventDto
| Name | Type | Is it required? | Description | Example value |
|---|---|---|---|---|
| name | string | yes | Webhook name | Create User |
| nameEn | string | yes | Webhook English name | Create User |
| value | string | yes | Webhook event | user:created |
| category | string | yes | Webhook event category | user |