- Development Integration
- /
- SDK
- /
- Java
- /
Management module
- /
Manage Webhook
- /
- Get Webhook event list
¶ Get Webhook event 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 this document description is incorrect, please refer to V3 API.
Return event list and category list
¶ Method Name
ManagementClient.getWebhookEventList
¶ Request Parameters
| Name | Type | Is it required | Default Value | Description | Example Value |
|---|
¶ Sample Code
package test.management;
import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CostGetCurrentUsageRespDto;
import cn.authing.sdk.java.dto.WebhookEventListRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;
public class GetWebhookEventListTest {
// Need to be replaced with your GenAuth Access Key ID
private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
// Need to be replaced with your GenAuth Access Key Secret
private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";
public static void main(String[] args) throws Throwable {
ManagementClientOptions clientOptions = new ManagementClientOptions();
clientOptions.setAccessKeyId(ACCESS_KEY_ID);
clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
// If you are a private deployment customer, you need to set the GenAuth service domain name
// clientOptions.setHost("https://api.your-authing-service.com");
ManagementClient client = new ManagementClient(clientOptions);
WebhookEventListRespDto webhookEventList = client.getWebhookEventList();
System.out.println(JsonUtils.serialize(webhookEventList));
}
}
¶ 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 (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 | WebhookEventListData | Response data |
Example Results:
{
"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 | Example Value |
|---|---|---|---|---|
| categories | array | Yes | Category list NestedType: WebhookCategoryDto. | |
| events | array | Yes | Event list NestedType: WebhookEventDto. |
¶ WebhookCategoryDto
| Name | Type | Is it required | Description | Example Value |
|---|---|---|---|---|
| name | string | Yes | Webhook TypeName | User |
| nameEn | string | Yes | Webhook TypeEnglishName | 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 |
