- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
管理 Webhook
- /
- 获取 Webhook 列表
¶ Get Webhook List
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.
Get the webhook list, you can select the number of pages and paging size to get
¶ Method name
ManagementClient.list_webhooks
¶ Request parameters
| Name | Type | Is it required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| page | number | No | 1 | Current page number, starting from 1 | 1 |
| limit | number | No | 10 | Number per page, the maximum cannot exceed 50, the default is 10 | 10 |
¶ Request response
Type: GetWebhooksRespDto
| 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 (successful requests are not returned). For a detailed list of error codes, see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | GetWebhooksData | Response data |
Sample result:
{
"statusCode": 200,
"message": "Operation successful",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"totalCount": 1,
"list": {
"webhookId": "6229ffaxxxxxxxxcade3e3d9",
"createdAt": "2022-07-03T02:20:30.000Z",
"updatedAt": "2022-07-03T02:20:30.000Z",
"name": "User creation event",
"url": "https://example.com/callback",
"contentType": "application/json",
"enabled": true,
"events": "[\"user:created\"]",
"secret": "xxxxxxxxxxxx"
}
}
}
¶ Data structure
¶ GetWebhooksData
| Name | Type | Is it required | Description | Sample value |
|---|---|---|---|---|
| totalCount | number | Yes | Total number of records | 1 |
| list | array | Yes | Return list Nested type: WebhookDto. |
¶ WebhookDto
| Name | Type | Required | Description | Sample value |
|---|---|---|---|---|
| webhookId | string | Yes | Webhook ID | 6229ffaxxxxxxxxcade3e3d9 |
| createdAt | string | Yes | Creation time | 2022-07-03T02:20:30.000Z |
| updatedAt | string | Yes | Update time | 2022-07-03T02:20:30.000Z |
| name | string | Yes | Webhook name | User created event |
| url | string | yes | Webhook callback address | https://example.com/callback |
| contentType | string | yes | Request data format | application/json |
| enabled | boolean | yes | Enabled | true |
| events | array | no | User's real name, not unique. Example value: Zhang San | ["user:created"] |
| secret | string | no | Request key | xxxxxxxxxxxx |