Create a Webhook

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If the description of this document is incorrect, please refer to the V3 API.

You need to specify the Webhook name, Webhook callback address, request data format, and user real name to create a Webhook. You can also choose whether to enable and request a key to create it

Method name

ManagementClient.createWebhook

Request parameters

Name	Type	Required	Default value	Description	Sample value
contentType	string	Yes	-	Request data format	application/json
events	string[]	Yes	-	User's real name, not unique. Example value: Zhang San	["user:created"]
url	string	yes	-	Webhook callback address	https://example.com/callback
name	string	yes	-	Webhook name	User creation event
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 GenAuth Service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.createWebhook({
    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: CreateWebhookRespDto

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
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 creation 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 creation 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