Modify Webhook configuration

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.

You need to specify webhookId, and you can specify webhook name, webhook callback address, request data format, user real name, whether to enable, and request key parameters to modify webhook

Method name

ManagementClient.updateWebhook

Request parameters

Name	Type	Required	Default value	Description	Sample value
webhookId	string	Yes	-	Webhook ID	6229ffaxxxxxxxxcade3e3d9
name	string	No	-	Webhook name	User created event
url	string	No	-	Webhook callback address	https://example.com/callback
events	string[]	No	-	User's real name, not unique. Example value: Zhang San	["user:created"]
contentType	string	No	-	Request data format	application/json
enabled	boolean	No	-	Enabled	true
secret	string	No	-	Request key	xxxxxxxxxxxx

Example 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 it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.updateWebhook({
    webhookId: "6229ffaxxxxxxxxcade3e3d9",
    name: "User creation event",
    url: "https://example.com/callback",
    events: ["user:created"],
    contentType: Models.WebhookDto.contentType.APPLICATION_JSON,
    enabled: true,
    secret: "xxxxxxxxxxxx",
  });

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

Request response

Type: UpdateWebhooksRespDto

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
requestId	string	Request ID. Returned when the request fails.
data	<a WebhookDto	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "webhookId": "6229ffaxxxxxxxxcade3e3d9",
    "createdAt": "2022-07-03T02:20:30.000Z",
    "updatedAt": "2022-07-03T02:20:30.000Z",
    "name": "User created event",
    "url": "https://example.com/callback",
    "contentType": "application/json",
    "enabled": true,
    "events": "[\"user:created\"]",
    "secret": "xxxxxxxxxxxx"
  }
}

Data structure

WebhookDto

Name	Type	Is it 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 or not	true
events	array	no	User's real name, not unique. Example value: Zhang San	["user:created"]
secret	string	no	Request key	xxxxxxxxxxxx