Get the list of Webhook events

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.getWebhookEventList

Request parameters

Name	Type	Required	Default value	Description	Sample value

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If you are a privately deployed customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.getWebhookEventList();

  console.log(JSON.stringify(result, null, 2));
})();

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 request is not returned). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a 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: <a WebhookCategoryDto.
events	array	Yes	Event list Nested type: <a 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	Sample 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